gkhtmltopdf 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 450c50b4a300eb003c28a7d3df213ed05ec5ec0626172ef178966f693af4cf5d
-  data.tar.gz: 0a80041e7a625a55ba11f7636b25a2ebee2a2500e3a6df9d0d8e60c49300a4c9
+  metadata.gz: 693828b2a9f004f9038b744c5d4a527a46f27ca55ad7c3d4638478aa2a747ade
+  data.tar.gz: 418727b131d4305641bcb66df639c961aabc73de334fd599b06d772f2b0557ba
 SHA512:
-  metadata.gz: ca97c9e7eeb874af9258869c4ead4d3dfbdd68f641afed5baaa66f5bdbf20dc1fd9b851039ba7fdc231df8f7ecd7b01b2b5768dddeace29c0c42608c469725ec
-  data.tar.gz: 2feea957d0d915498bb92378a6ff734ffce7922da83f1cadb4765090eb09d5d3030b38525c3295ec31fe1826453f34a4bfde5f0343aad8fef9d6fc943ac6234c
+  metadata.gz: 8776f073004b0e5dba496316e4c95e18121784be2430b12f679dc900cfee41e7002befda8fe022f30739e8bdf33c76ce7c51cd625ed5e5095cc95f4eb60b4d3f
+  data.tar.gz: 3df53840690e009d5c39a18710867505eff22e0bbb0d6711dfc6f8cc44a73442c02f1d6f5b5c1c3ac9f5c5c327f61d377bbab9a73dafea0124ff4a20e378426b

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All noteworthy changes to this project will be documented in this file.
 
+## 1.1.0 / 2026-06-29
+
+- UA設定機能の追加
+- mktmpdirの明示的な削除
+- ubuntuでの動かし方とか修正
+
 ## 1.0.0 / 2026-03-19
 
 - Added serial processing for multiple files and URLs.

data/README.md

@@ -5,6 +5,11 @@ Gkhtmltopdf is mean Gecko HTML to PDF converter.
 Developed as an alternative to wkhtmltopdf.
 This gem converts HTML to PDF using Firefox's Geckodriver.
 
+[![Gem Version](https://badge.fury.io/rb/gkhtmltopdf.svg)](https://badge.fury.io/rb/gkhtmltopdf)
+![Gem Total Downloads](https://img.shields.io/gem/dt/gkhtmltopdf)
+![GitHub License](https://img.shields.io/github/license/fantasia-tech/gkhtmltopdf-rb)
+![Rspec](https://github.com/fantasia-tech/gkhtmltopdf-rb/actions/workflows/main.yml/badge.svg)
+
 ---
 
 ## How to
@@ -12,36 +17,42 @@ This gem converts HTML to PDF using Firefox's Geckodriver.
 ### 1. Install
 
 1. [Firefox](https://www.firefox.com)
-   - Ubuntu
-     ```bash
-     $ apt install -y firefox
-     $ apt install -y fonts-noto # recommended
-     ```
-   - Debian
-     ```bash
-     $ apt install -y firefox-esr
-     $ apt install -y fonts-noto # recommended
-     ```
+  - Ubuntu  
+    > The snap does not work correctly, so please install it from the [official source](https://support.mozilla.org/en-US/kb/install-firefox-linux).
+    ```bash
+    $ wget -q https://packages.mozilla.org/apt/repo-signing-key.gpg -O- | sudo tee /etc/apt/keyrings/packages.mozilla.org.asc > /dev/null
+    $ echo "deb [signed-by=/etc/apt/keyrings/packages.mozilla.org.asc] https://packages.mozilla.org/apt mozilla main" | tee -a /etc/apt/sources.list.d/mozilla.list > /dev/null
+    $ tee /etc/apt/preferences.d/mozilla > /dev/null << EOF
+      Package: *
+      Pin: origin packages.mozilla.org
+      Pin-Priority: 1000
+      EOF
+    $ apt install -y firefox
+    $ apt install -y fonts-noto # recommended
+    ```
+  - Debian  
+    ```bash
+    $ apt install -y firefox-esr
+    $ apt install -y fonts-noto # recommended
+    ```
 
 2. [geckodriver](https://github.com/mozilla/geckodriver)
-  - Linux (Ubuntu / Debian)
+  - Linux (Ubuntu / Debian)  
     ```bash
     $ wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O /tmp/geckodriver.tar.gz
     $ tar -xzf /tmp/geckodriver.tar.gz -C /usr/local/bin
     ```
 
 3. gem install
-  - bundler
+  - bundler  
     ```bash
     $ bundle add gkhtmltopdf
     ```
-  - other
+  - other  
     ```bash
     $ gem install gkhtmltopdf
     ```
 
----
-
 ### 2. Using
 
 #### Ruby
@@ -57,6 +68,8 @@ Gkhtmltopdf.convert('https://example.com', 'example_com.pdf')
 Gkhtmltopdf.convert('file:///foo/bar/test.html', 'local.pdf')
 # with option (print background)
 Gkhtmltopdf.convert('https://f6a.net/oss/', 'with_bg.pdf', print_options: {background: true})
+# with option (set custom user-agent)
+Gkhtmltopdf.convert('https://f6a.net/oss/', 'ua.pdf', user_agent: 'YOUR USER AGENT')
 ```
 
 Additionally, in version 1.0.0 we added the following syntax.  
@@ -69,6 +82,10 @@ Gkhtmltopdf.open do |gkh2p|
   gkh2p.save_pdf('file:///foo/bar/test.html', 'local.pdf')
   gkh2p.save_pdf('https://f6a.net/oss/', 'with_bg.pdf', print_options: {background: true})
 end
+# set custom user-agent
+Gkhtmltopdf.open(user_agent: 'YOUR USER AGENT') do |gkh2p|
+  gkh2p.save_pdf('https://f6a.net/oss/', 'ua.pdf')
+end
 ```
 
 #### Shell
@@ -80,6 +97,8 @@ $ gkhtmltopdf https://example.com/ example_com.pdf
 $ gkhtmltopdf /foo/bar/test.html local.pdf
 # with option (print background)
 $ gkhtmltopdf https://f6a.net/oss/ with_bg.pdf --background
+# with option (set custom user-agent)
+$ gkhtmltopdf https://f6a.net/oss/ ua.pdf --user-agent "YOUR USER AGENT"
 # other option
 $ gkhtmltopdf --help
 ```
@@ -105,7 +124,7 @@ Attackers could potentially generate PDFs of internal network resources (e.g., `
 
 ---
 
-## Errors
+## Expected Errors
 
 The following errors inherit `Gkhtmltopdf::Error`, so you can handle them as follows:
 
@@ -132,6 +151,12 @@ Response from Firefox/Geckodriver is not as expected.
 
 ---
 
+## Documents
+
+- [ForDeveloper](/docs/ForDeveloper.md)
+
+---
+
 ## Acknowledgments & Third-Party Licenses
 
 This gem acts as a wrapper and communicates with the following external open-source tools.

data/TODO.md

@@ -17,9 +17,20 @@
 - [x] エラー処理
 - [x] 起動時の待機時間オプション
 
-## 今後検討
+## 完了 v1.1.0
+
+- [x] UA設定機能の追加
+- [x] mktmpdirの明示的な削除
+
+## つぎ v1.2.0
+
+- [ ] 設定のStruct化?(default切り出し)
+- [ ] pdfをsaveせずバイナリを直接返却するメソッドの追加
+- [ ] 肥大化したconvert.rbの分割( `Gkhtmltopdf::PDF` とかつくるか)
+
+## 検討中
 
-- [ ] UA設定機能
 - [ ] ポート範囲設定?
-- [ ] configファイルからオプションを設定?
 - [ ] YARD追加
+- [ ] FireFox timeout
+- [ ] configファイルからオプションを設定?

data/{Dockerfile → dockerfiles/Dockerfile.debian13-ruby32}

@@ -1,3 +1,5 @@
+# escape=\
+# syntax=docker/dockerfile:1.7
 FROM ruby:3.2-slim
 
 RUN apt-get update

data/dockerfiles/Dockerfile.ubuntu24-ruby32

@@ -0,0 +1,28 @@
+FROM ubuntu:noble
+
+RUN apt-get update
+RUN apt-get install -y ruby3.2 bundler
+RUN apt-get install -y git wget xz-utils build-essential libyaml-dev
+
+# Install Noto Fonts
+RUN apt-get install -y fonts-noto
+
+# Install Firefox
+RUN wget -q https://packages.mozilla.org/apt/repo-signing-key.gpg -O- | tee /etc/apt/keyrings/packages.mozilla.org.asc > /dev/null
+RUN echo "deb [signed-by=/etc/apt/keyrings/packages.mozilla.org.asc] https://packages.mozilla.org/apt mozilla main" | tee -a /etc/apt/sources.list.d/mozilla.list > /dev/null
+RUN tee /etc/apt/preferences.d/mozilla > /dev/null << EOF
+Package: *
+Pin: origin packages.mozilla.org
+Pin-Priority: 1000
+EOF
+RUN apt-get update
+RUN apt-get install -y firefox
+
+# Install Geckodriver
+RUN wget "https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz" -O geckodriver.tar.gz
+RUN tar -xzf geckodriver.tar.gz -C /usr/local/bin
+
+COPY . /app
+WORKDIR /app
+RUN bundle install
+CMD ["bundle", "exec", "rspec"]

data/docs/ForDeveloper.md

@@ -0,0 +1,17 @@
+# for Developer
+
+## Test
+
+```bash
+$ docker build -f ./dockerfiles/Dockerfile.debian13-ruby32 . -t gkhtmltopdf-d13r32
+$ docker build -f ./dockerfiles/Dockerfile.ubuntu24-ruby32 . -t gkhtmltopdf-u24r32
+$ docker run --rm gkhtmltopdf-d13r32
+$ docker run --rm gkhtmltopdf-u24r32
+$ docker rmi gkhtmltopdf-d13r32
+$ docker rmi gkhtmltopdf-u24r32
+```
+
+## Build
+
+```
+```

data/exe/gkhtmltopdf

@@ -12,33 +12,37 @@ options = {
 parser = OptionParser.new do |opts|
   opts.banner = "Usage: gkhtmltopdf [options] <URL_OR_FILE> <OUTPUT_PDF>"
 
-  opts.on("-O", "--orientation [PORTRAIT|LANDSCAPE]", "default: portrait") do |v|
+  opts.on("-O", "--orientation ORIENTATION", ["portrait", "landscape"], "ORIENTATION portrait or landscape (default: portrait)") do |v|
     options[:print_options][:orientation] = v.downcase
   end
 
+  opts.on("--user-agent USERAGENT", String, "Browser custom USERAGENT") do |v|
+    options[:user_agent] = v
+  end
+
   opts.on("--background", "Print background") do
     options[:print_options][:background] = true
   end
 
-  opts.on("--margin-top [CM]", Float, "margin top (cm)") do |v|
+  opts.on("--margin-top CM", Float, "margin top CM") do |v|
     options[:print_options][:margin] ||= {}
     options[:print_options][:margin][:top] = v
   end
 
-  opts.on("--margin-bottom [CM]", Float, "margin bottom (cm)") do |v|
+  opts.on("--margin-bottom CM", Float, "margin bottom CM") do |v|
     options[:print_options][:margin] ||= {}
     options[:print_options][:margin][:bottom] = v
   end
 
-  opts.on("--firefox-path [PATH]", "Firefox custom PATH") do |v|
+  opts.on("--firefox-path PATH", String, "Firefox custom PATH") do |v|
     options[:firefox_path] = v
   end
 
-  opts.on("--geckodriver-path [PATH]", "Geckodriver custom PATH") do |v|
+  opts.on("--geckodriver-path PATH", String, "Geckodriver custom PATH") do |v|
     options[:geckodriver_path] = v
   end
 
-  opts.on("--launch-max-wait-time [NUM]", Integer, "Launch max wait time (approx: NUM * 0.1sec)") do |v|
+  opts.on("--launch-max-wait-time NUM", Integer, "Launch max wait time (approx: NUM * 0.1sec)") do |v|
     options[:wait_time] = v
   end
 
@@ -74,6 +78,7 @@ begin
   init_options[:firefox_path] = options.delete(:firefox_path) if options[:firefox_path]
   init_options[:geckodriver_path] = options.delete(:geckodriver_path) if options[:geckodriver_path]
   init_options[:wait_time] = options.delete(:wait_time) if options[:wait_time]
+  init_options[:user_agent] = options.delete(:user_agent) if options[:user_agent]
 
   Gkhtmltopdf.convert(input_url, output_path, print_options: options[:print_options], **init_options)
 

data/lib/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gkhtmltopdf
   class Error < StandardError; end
 

data/lib/gkhtmltopdf/converter.rb

@@ -1,24 +1,32 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
 require 'base64'
 require 'uri'
 require 'socket'
+require 'tmpdir'
+require 'fileutils'
 
 module Gkhtmltopdf
   class Converter
-    def open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil)
+    DEFAULT_FX_USER_AGENT = "gkhtmltopdf-rb(v#{VERSION}) by firefox and gecko".freeze
+
+    def open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil)
       @geckodriver_path = resolve_geckodriver_path!(geckodriver_path)
       @firefox_path = resolve_firefox_path!(firefox_path)
       @port = port || get_free_port
       @base_url = "http://127.0.0.1:#{@port}"
       @pid = spawn("#{@geckodriver_path} --port #{@port}", out: File::NULL, err: File::NULL)
       wait_time ||= 20
+      @profile_path = gen_tmp_profile(user_agent)
       wait_for_gk(wait_time)
       create_session!
     end
 
     def close
       delete_session! if @session_id
+      delete_tmp_profile! if @profile_path
       begin
         unless @pid.nil?
           Process.kill('TERM', @pid)
@@ -101,12 +109,24 @@ module Gkhtmltopdf
       raise BrowserError, "Failed to launch geckodriver (port #{@port})"
     end
 
+    def gen_tmp_profile(ua = nil)
+      tmp_profile_path = Dir.mktmpdir
+      ua ||= DEFAULT_FX_USER_AGENT
+      escaped_user_agent = JSON.generate(ua)
+      profile = []
+      profile << '# set gkhtmltopdf default profile'
+      profile << "user_pref(\"general.useragent.override\", #{escaped_user_agent});\n"
+      File.open(File.join(tmp_profile_path, 'user.js'), 'w') do |f|
+        profile.each { |line| f.puts(line) }
+      end
+      tmp_profile_path
+    end
+
     def post(path, payload)
       uri = URI("#{@base_url}#{path}")
       req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
       req.body = payload.to_json
       res = Net::HTTP.start(uri.hostname, uri.port) { |http| http.request(req) }
-
       begin
         JSON.parse(res.body)
       rescue JSON::ParserError
@@ -115,7 +135,7 @@ module Gkhtmltopdf
     end
 
     def create_session!
-      firefox_options = { args: ["-headless"] }
+      firefox_options = { args: ["-headless", '--profile', @profile_path] }
       firefox_options[:binary] = @firefox_path if @firefox_path != 'firefox'
 
       payload = {
@@ -163,6 +183,10 @@ module Gkhtmltopdf
       @session_id = nil
     end
 
+    def delete_tmp_profile!
+      FileUtils.remove_entry_secure(@profile_path)
+    end
+
     def validate_url_scheme!(url_string)
       parsed_url = URI.parse(url_string)
       allowed_schemes = ['http', 'https', 'file']

data/lib/gkhtmltopdf/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gkhtmltopdf
   class DSL
     def initialize

data/lib/gkhtmltopdf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gkhtmltopdf
-  VERSION = "1.0.0"
+  VERSION = '1.1.0'
 end

data/lib/gkhtmltopdf.rb

@@ -6,17 +6,17 @@ require_relative 'gkhtmltopdf/dsl'
 require_relative 'errors'
 
 module Gkhtmltopdf
-  def self.convert(url, output_path, geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, print_options: {})
+  def self.convert(url, output_path, geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil, print_options: {})
     converter = DSL.new
-    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port)
+    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port, user_agent: user_agent)
     converter.save_pdf(url, output_path, print_options: print_options)
   ensure
     converter.close
   end
 
-  def self.open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, &block)
+  def self.open(geckodriver_path: nil, firefox_path: nil, wait_time: nil, port: nil, user_agent: nil, &block)
     converter = DSL.new
-    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port)
+    converter.open(geckodriver_path: geckodriver_path, firefox_path: firefox_path, wait_time: wait_time, port: port, user_agent: user_agent)
     yield converter
   ensure
     converter.close

data/spec/gkhtmltopdf/converter_spec.rb

@@ -17,12 +17,16 @@ RSpec.describe Gkhtmltopdf::Converter do
   end
   describe '#save_pdf' do
     before { converter.open }
-    subject { converter.save_pdf(url, output_path) }
     let(:url) { "file://#{file_fixture('test.html')}" }
-    let(:output_path) { File.join(Dir.mktmpdir, 'output.pdf') }
+    let(:output_path) { Dir.mktmpdir }
+    let(:output) { File.join(output_path, 'output.pdf') }
+    after { FileUtils.remove_entry_secure(output_path) }
+
+    subject { converter.save_pdf(url, output) }
+
     it {
-      expect { subject }.to change { Dir.glob(output_path).count }.from(0).to(1)
-      expect(File.binread(output_path)).to include('/FontName')
+      expect { subject }.to change { Dir.glob(output).count }.from(0).to(1)
+      expect(File.binread(output)).to include('/FontName')
     }
   end
   describe '#resolve_geckodriver_path!' do

data/spec/gkhtmltopdf_spec.rb

@@ -3,7 +3,9 @@ require 'spec_helper'
 RSpec.describe Gkhtmltopdf do
   describe '.convert' do
     let(:url) { 'https://f6a.net/oss/' }
-    let(:output) { File.join(Dir.mktmpdir, 'output.pdf') }
+    let(:output_path) { Dir.mktmpdir }
+    let(:output) { File.join(output_path, 'output.pdf') }
+    after { FileUtils.remove_entry_secure(output_path) }
 
     subject { Gkhtmltopdf.convert(url, output) }
 
@@ -21,6 +23,7 @@ RSpec.describe Gkhtmltopdf do
   describe '.open' do
     let(:url) { 'https://f6a.net/oss/' }
     let(:output_path) { Dir.mktmpdir }
+    after { FileUtils.remove_entry_secure(output_path) }
 
     subject do
       Gkhtmltopdf.open do |gk|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gkhtmltopdf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kazuki Sakane
@@ -78,11 +78,13 @@ files:
 - ".rspec"
 - ".ruby-version"
 - CHANGELOG.md
-- Dockerfile
 - LICENSE
 - README.md
 - Rakefile
 - TODO.md
+- dockerfiles/Dockerfile.debian13-ruby32
+- dockerfiles/Dockerfile.ubuntu24-ruby32
+- docs/ForDeveloper.md
 - exe/gkhtmltopdf
 - lib/errors.rb
 - lib/gkhtmltopdf.rb