gkhtmltopdf 0.9.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc9b80ee14f3f1a0eae169fbd5b1b48a3a14f79bccf8c23cb445720ccf256ac
-  data.tar.gz: 84596639fd0dfc5a82a5d9e16373d7b00652688f747a6c8e6fd71a9eb9280038
+  metadata.gz: 693828b2a9f004f9038b744c5d4a527a46f27ca55ad7c3d4638478aa2a747ade
+  data.tar.gz: 418727b131d4305641bcb66df639c961aabc73de334fd599b06d772f2b0557ba
 SHA512:
-  metadata.gz: 587c445948f7c8552a51ad81bf98e94fb6d76d8699faa59cfbf4138633585b9a3b64cd2ad0a307723908473d7f3258434346771bc6f4921b88628f07da101b81
-  data.tar.gz: 8d5edab4799522f1121a0fc2801fff8d5133a0cd58f4a98398f65b90b40dcabda48de29ebe442341e562b2ed27c045b7d312d01a78432bb72ef1e561057a56c2
+  metadata.gz: 8776f073004b0e5dba496316e4c95e18121784be2430b12f679dc900cfee41e7002befda8fe022f30739e8bdf33c76ce7c51cd625ed5e5095cc95f4eb60b4d3f
+  data.tar.gz: 3df53840690e009d5c39a18710867505eff22e0bbb0d6711dfc6f8cc44a73442c02f1d6f5b5c1c3ac9f5c5c327f61d377bbab9a73dafea0124ff4a20e378426b

data/CHANGELOG.md

@@ -2,18 +2,40 @@
 
 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.
+  - 複数ファイル&URLの直列処理追加
+- Separated the Gkhtmltopdf::Error into many.
+  - エラーを分離
+- Add and Fixed test.
+  - テスト追加&修正
+
 ## 0.9.0 / 2026-03-13
 
 - Achieved 100% test coverage.🎉
+  - テストカバレッジ100%!
 - Fixed github url.
+  - github URL 修正
 
 ## 0.8.0 / 2026-03-10
 
 - Added parallel processing support with automatic free port checking.
+  - 空きポートの処理追加による並列実行追加
 - Added print options.
+  - プリントオプションの追加
 - Added Dockerfile (Debian compatibility verified).
+  - Dockerfile追加(Debian互換検証)
 - Added error message display when PATH errors occur.
+  -  PATH関連のエラーメッセージ追加
 
 ## 0.1.0 / 2026-01-09
 
 - Initial release.
+  - 初期リリース

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,49 +17,78 @@ This gem converts HTML to PDF using Firefox's Geckodriver.
 ### 1. Install
 
 1. [Firefox](https://www.firefox.com)
-    - for Ubuntu
-        ```Ubuntu
-        $ apt install -y firefox
-        ```
-    - for Debian
-        ```bash
-        $ apt install -y firefox-esr
-        ```
+  - 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)
-    - for 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
-        ```bash
-        $ bundle add gkhtmltopdf
-        ```
-    - other
-        ```bash
-        $ gem install gkhtmltopdf
-        ```
+  - 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  
+    ```bash
+    $ bundle add gkhtmltopdf
+    ```
+  - other  
+    ```bash
+    $ gem install gkhtmltopdf
+    ```
 
 ### 2. Using
 
-#### ruby
+#### Ruby
 
 > **⚠️ Security Warning for Web Frameworks (e.g., Ruby on Rails):**
 > If you are accepting URLs from untrusted users, you must implement strict SSRF protection. Do not pass user-input URLs directly without network-level isolation. Please read the [SSRF](#what-is-ssrf) section below for details.
 
 ```ruby
+require 'gkhtmltopdf'
 # over network
 Gkhtmltopdf.convert('https://example.com', 'example_com.pdf')
 # local file
 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')
 ```
 
-#### shell
+Additionally, in version 1.0.0 we added the following syntax.  
+If you want to generate multiple PDFs faster, use this:
+
+```ruby
+require 'gkhtmltopdf'
+Gkhtmltopdf.open do |gkh2p|
+  gkh2p.save_pdf('https://example.com', 'example_com.pdf')
+  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
 
 ```bash
 # over network
@@ -63,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
 ```
@@ -88,6 +124,39 @@ Attackers could potentially generate PDFs of internal network resources (e.g., `
 
 ---
 
+## Expected Errors
+
+The following errors inherit `Gkhtmltopdf::Error`, so you can handle them as follows:
+
+```ruby
+begin
+  Gkhtmltopdf.convert('ftp://example.com', 'example_com.pdf')
+rescue Gkhtmltopdf::Error => e
+  puts e.class   # -> Gkhtmltopdf::URLSchemeInvalid
+  puts e.message # -> Invalid URL scheme: (ftp)
+end
+```
+
+### Gkhtmltopdf::PathUnresolvedError
+
+Firefox or Geckodriver path unresolved. Follow the installation steps in [1. Install](#1-install) to set up.
+
+### Gkhtmltopdf::URLSchemeInvalid
+
+Raised when the URL scheme is invalid (e.g., `ftp://`, `about://`) or the hostname is missing (e.g., `f6a.net`).
+
+### Gkhtmltopdf::BrowserError
+
+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

@@ -1,6 +1,6 @@
 # TODO
 
-## 完了
+## 完了 v0.9.0
 
 - [x] 並列処理対応(自動空きportチェック)
 - [x] 印刷オプションの追加
@@ -8,11 +8,29 @@
 - [x] PATHエラー時の表示追加
 - [x] 入力値検証
 - [x] テストカバレッジ100%
+- [x] RubyGemsで公開
+- [x] 多言語対応について
 
-## 未了
+## 完了 v1.0.0
 
-- [ ] RubyGemsで公開
-- [ ] UA設定機能
-- [ ] ポート範囲設定
-- [ ] 複数ファイル&URLの直列実行による高速化
-- [ ] configファイルからオプションを設定
+- [x] 複数ファイル&URLの直列実行による高速化
+- [x] エラー処理
+- [x] 起動時の待機時間オプション
+
+## 完了 v1.1.0
+
+- [x] UA設定機能の追加
+- [x] mktmpdirの明示的な削除
+
+## つぎ v1.2.0
+
+- [ ] 設定のStruct化?(default切り出し)
+- [ ] pdfをsaveせずバイナリを直接返却するメソッドの追加
+- [ ] 肥大化したconvert.rbの分割( `Gkhtmltopdf::PDF` とかつくるか)
+
+## 検討中
+
+- [ ] ポート範囲設定?
+- [ ] YARD追加
+- [ ] FireFox timeout
+- [ ] configファイルからオプションを設定?

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

@@ -1,8 +1,13 @@
+# escape=\
+# syntax=docker/dockerfile:1.7
 FROM ruby:3.2-slim
 
 RUN apt-get update
 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 apt-get install -y firefox-esr
 

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,32 +12,40 @@ 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|
+    options[:wait_time] = v
+  end
+
   opts.on("-v", "--version", "display version") do
     puts "Gkhtmltopdf version #{Gkhtmltopdf::VERSION}"
     exit
@@ -69,9 +77,10 @@ begin
   init_options = {}
   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]
 
-  converter = Gkhtmltopdf::Converter.new(**init_options)
-  converter.convert(input_url, output_path, print_options: options[:print_options])
+  Gkhtmltopdf.convert(input_url, output_path, print_options: options[:print_options], **init_options)
 
   puts "✅ Completed PDF generation!"
 

data/lib/errors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gkhtmltopdf
+  class Error < StandardError; end
+
+  class PathUnresolvedError < Error
+    def initialize(name)
+      message = "#{name} is not found. Please ensure #{name} is installed and either in your PATH or specify the path during initialization."
+      super(message)
+    end
+  end
+
+  class BrowserError < Error; end
+
+  class URLSchemeInvalid < Error
+    def initialize(url_scheme)
+      message = "Invalid URL scheme: (#{url_scheme})"
+      super(message)
+    end
+  end
+end

data/lib/gkhtmltopdf/converter.rb

@@ -1,40 +1,48 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
 require 'base64'
 require 'uri'
 require 'socket'
+require 'tmpdir'
+require 'fileutils'
 
 module Gkhtmltopdf
   class Converter
-    def initialize(geckodriver_path: nil, firefox_path: 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 convert(url, output_path, print_options: {})
-      validate_url_scheme!(url)
-
-      pid = spawn("#{@geckodriver_path} --port #{@port}", out: File::NULL, err: File::NULL)
-      wait_for_server
-
-      session_id = nil
+    def close
+      delete_session! if @session_id
+      delete_tmp_profile! if @profile_path
       begin
-        session_id = create_session
-        navigate(session_id, url)
-        
-        pdf_base64 = print_pdf(session_id, print_options)
-        File.binwrite(output_path, Base64.decode64(pdf_base64))
-      ensure
-        delete_session(session_id) if session_id
-        begin
-          Process.kill('TERM', pid)
-          Process.wait(pid)
-        rescue Errno::ESRCH, Errno::ECHILD
-          # nothing to do if the process is already terminated
+        unless @pid.nil?
+          Process.kill('TERM', @pid)
+          Process.wait(@pid)
         end
+      rescue Errno::ESRCH, Errno::ECHILD
+        # nothing to do if the process is already terminated
       end
+      nil
+    end
+
+    def save_pdf(url, output_path, print_options: {})
+      validate_url_scheme!(url)
+      navigate(url)
+      pdf_base64 = print_pdf(print_options)
+      File.binwrite(output_path, Base64.decode64(pdf_base64))
     end
 
     private
@@ -49,7 +57,7 @@ module Gkhtmltopdf
     def resolve_geckodriver_path!(provided_path)
       path = provided_path || find_default_geckodriver
       unless path
-        raise Error, "Geckodriver is not found. Please ensure Geckodriver is installed and either in your PATH or specify the path during initialization."
+        raise PathUnresolvedError, 'Geckodriver'
       end
       path
     end
@@ -57,7 +65,7 @@ module Gkhtmltopdf
     def resolve_firefox_path!(provided_path)
       path = provided_path || find_default_firefox
       unless path
-        raise Error, "Firefox is not found. Please ensure Firefox is installed and either in your PATH or specify the path during initialization."
+        raise PathUnresolvedError, 'Firefox'
       end
       path
     end
@@ -89,16 +97,29 @@ module Gkhtmltopdf
       common_paths.find { |path| File.executable?(path) && !File.directory?(path) }
     end
 
-    def wait_for_server
-      10.times do
+    def wait_for_gk(num)
+      num.times do
         begin
           Net::HTTP.get(URI("#{@base_url}/status"))
           return
         rescue Errno::ECONNREFUSED
-          sleep 0.2
+          sleep 0.1
         end
       end
-      raise Error, "Failed to launch geckodriver (port #{@port})"
+      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)
@@ -106,16 +127,15 @@ module Gkhtmltopdf
       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
-        raise Error, "Invalid geckodriver response (Status: #{res.code}): #{res.body}"
+        raise BrowserError, "Invalid json response (Status: #{res.code}): #{res.body}"
       end
     end
 
-    def create_session
-      firefox_options = { args: ["-headless"] }
+    def create_session!
+      firefox_options = { args: ["-headless", '--profile', @profile_path] }
       firefox_options[:binary] = @firefox_path if @firefox_path != 'firefox'
 
       payload = {
@@ -129,16 +149,16 @@ module Gkhtmltopdf
 
       response = post("/session", payload)
       value = response["value"]
-      raise Error, "Failed to launch Firefox: #{value}" if value["error"]
+      raise BrowserError, "Failed to create session: #{value}" if value["error"]
 
-      value["sessionId"]
+      @session_id = value["sessionId"]
     end
 
-    def navigate(session_id, url)
-      post("/session/#{session_id}/url", { url: url })
+    def navigate(url)
+      post("/session/#{@session_id}/url", { url: url })
     end
 
-    def print_pdf(session_id, user_options)
+    def print_pdf(user_options)
       default_options = {
         background: false,
         shrinkToFit: true,
@@ -149,25 +169,30 @@ module Gkhtmltopdf
 
       payload = default_options.merge(user_options)
 
-      response = post("/session/#{session_id}/print", payload)
+      response = post("/session/#{@session_id}/print", payload)
       value = response["value"]
-      raise Error, "Failed to generate PDF: #{value}" if value["error"]
+      raise BrowserError, "Failed to generate PDF: #{value}" if value["error"]
 
       value
     end
 
-    def delete_session(session_id)
-      uri = URI("#{@base_url}/session/#{session_id}")
+    def delete_session!
+      uri = URI("#{@base_url}/session/#{@session_id}")
       req = Net::HTTP::Delete.new(uri)
       Net::HTTP.start(uri.hostname, uri.port) { |http| http.request(req) }
+      @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']
-      raise Error, 'URL scheme is nil' if parsed_url.scheme.nil?
+      raise URLSchemeInvalid, nil if parsed_url.scheme.nil?
       unless allowed_schemes.include?(parsed_url.scheme)
-        raise Error, "Invalid URL scheme: #{parsed_url.scheme}"
+        raise URLSchemeInvalid, parsed_url.scheme
       end
     end
   end

data/lib/gkhtmltopdf/dsl.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gkhtmltopdf
+  class DSL
+    def initialize
+      @converter = Converter.new
+    end
+
+    def open(options)
+      @converter.open(**options)
+    end
+
+    def close
+      @converter.close
+    end
+
+    def save_pdf(url, output_path, print_options: {})
+      @converter.save_pdf(url, output_path, print_options: print_options)
+    end
+  end
+end

data/lib/gkhtmltopdf/version.rb

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

data/lib/gkhtmltopdf.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "gkhtmltopdf/version"
-require_relative "gkhtmltopdf/converter"
+require_relative 'gkhtmltopdf/version'
+require_relative 'gkhtmltopdf/converter'
+require_relative 'gkhtmltopdf/dsl'
+require_relative 'errors'
 
 module Gkhtmltopdf
-  class Error < StandardError; end
-  
-  def self.convert(url, output_path, geckodriver_path: nil, firefox_path: nil, port: nil, print_options: {})
-    converter = Converter.new(geckodriver_path: geckodriver_path, firefox_path: firefox_path, port: port)
-    converter.convert(url, output_path, print_options: 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, 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, user_agent: nil, &block)
+    converter = DSL.new
+    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
   end
 end

data/spec/gkhtmltopdf/converter_spec.rb

@@ -1,14 +1,40 @@
 require 'spec_helper'
-require 'gkhtmltopdf'
 
 RSpec.describe Gkhtmltopdf::Converter do
-  let(:converter) { Gkhtmltopdf::Converter.allocate }
+  let(:converter) { Gkhtmltopdf::Converter.new }
+  after { converter.close }
+  describe '#open' do
+    subject { converter.open }
+    it {
+      subject
+      expect(converter.instance_variable_get(:@geckodriver_path)).to be_a(String)
+      expect(converter.instance_variable_get(:@firefox_path)).to be_a(String)
+      expect(converter.instance_variable_get(:@port)).to be_a(Integer)
+      expect(converter.instance_variable_get(:@base_url)).to be_a(String)
+      expect(converter.instance_variable_get(:@pid)).to be_a(Integer)
+      expect(converter.instance_variable_get(:@session_id)).to be_a(String)
+    }
+  end
+  describe '#save_pdf' do
+    before { converter.open }
+    let(:url) { "file://#{file_fixture('test.html')}" }
+    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).count }.from(0).to(1)
+      expect(File.binread(output)).to include('/FontName')
+    }
+  end
   describe '#resolve_geckodriver_path!' do
     subject { converter.send(:resolve_geckodriver_path!, nil) }
     context 'geckodriver is not available' do
       before { allow(File).to receive(:executable?).and_return(false) }
       it 'raises an error' do
-        expect { subject }.to raise_error(Gkhtmltopdf::Error, /\AGeckodriver is not found./)
+        expect { subject }.to raise_error(Gkhtmltopdf::PathUnresolvedError, /\AGeckodriver is not found./)
       end
     end
   end
@@ -18,29 +44,45 @@ RSpec.describe Gkhtmltopdf::Converter do
     context 'firefox is not available' do
       before { allow(File).to receive(:executable?).and_return(false) }
       it 'raises an error' do
-        expect { subject }.to raise_error(Gkhtmltopdf::Error, /\AFirefox is not found./)
+        expect { subject }.to raise_error(Gkhtmltopdf::PathUnresolvedError, /\AFirefox is not found./)
       end
     end
   end
-  describe '#wait_for_server' do
-    subject { converter.send(:wait_for_server) }
+
+  describe '#wait_for_gk' do
+    subject { converter.send(:wait_for_gk, 0) }
     context 'fail launch geckodriver' do
       before { allow(Net::HTTP).to receive(:get).and_raise(Errno::ECONNREFUSED, 'Dummy error') }
       it 'raises an error' do
-        expect { subject }.to raise_error(Gkhtmltopdf::Error, /\AFailed to launch geckodriver \(port \)\Z/)
+        expect { subject }.to raise_error(Gkhtmltopdf::BrowserError, /\AFailed to launch geckodriver \(port \)\Z/)
       end
     end
   end
+
   describe '#post' do
-    let(:converter) { Gkhtmltopdf::Converter.new }
     subject { converter.send(:post, '/dummy', {test: :value}) }
     context 'Invalid json response from geckodriver' do
       before {
+        converter.instance_variable_set(:@base_url, 'http://test')
         allow(Net::HTTP).to receive(:start).and_return(Struct.new(:code, :body).new('200', 'invalid_json: 0123'))
       }
       it 'raises an error' do
-        expect { subject }.to raise_error(Gkhtmltopdf::Error, 'Invalid geckodriver response (Status: 200): invalid_json: 0123')
+        expect { subject }.to raise_error(Gkhtmltopdf::BrowserError, 'Invalid json response (Status: 200): invalid_json: 0123')
       end
     end
   end
+
+  describe '#validate_url_scheme!' do
+    subject { converter.send(:validate_url_scheme!, url_string) }
+    let(:url_string) { 'http://f6a.net' }
+    it { expect { subject }.not_to raise_error }
+    context 'scheme is nil' do
+      let(:url_string) { 'f6a.net' }
+      it { expect { subject }.to raise_error(Gkhtmltopdf::URLSchemeInvalid, 'Invalid URL scheme: ()') }
+    end
+    context 'invalid scheme' do
+      let(:url_string) { 'about://version' }
+      it { expect { subject }.to raise_error(Gkhtmltopdf::URLSchemeInvalid, 'Invalid URL scheme: (about)') }
+    end
+  end
 end

data/spec/gkhtmltopdf_spec.rb

@@ -1,15 +1,13 @@
 require 'spec_helper'
-require 'gkhtmltopdf'
-require 'tmpdir'
-require 'base64'
 
 RSpec.describe Gkhtmltopdf do
   describe '.convert' do
     let(:url) { 'https://f6a.net/oss/' }
-    let(:output) { File.join(Dir.mktmpdir, 'output.pdf') }
-    let(:hash) { {} }
+    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, **hash) }
+    subject { Gkhtmltopdf.convert(url, output) }
 
     it 'successful conversion' do
       expect { subject }.not_to raise_error 
@@ -18,7 +16,30 @@ RSpec.describe Gkhtmltopdf do
     context 'invalid URL' do
       let(:url) { 'ftp://example.com' }
       it 'raises an error' do
-        expect { subject }.to raise_error(Gkhtmltopdf::Error, 'Invalid URL scheme: ftp')
+        expect { subject }.to raise_error(Gkhtmltopdf::URLSchemeInvalid, 'Invalid URL scheme: (ftp)')
+      end
+    end
+  end
+  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|
+        (1..3).each { |n| gk.save_pdf("#{url}?test=#{n}", File.join(output_path, "#{n}.pdf")) }
+      end
+    end
+
+    it 'successful conversion' do
+      expect { subject }.to change { Dir.glob(File.join(output_path, '*.pdf')).count }.from(0).to(3)
+      expect { subject }.not_to raise_error
+    end
+
+    context 'invalid URL' do
+      let(:url) { 'ftp://example.com' }
+      it 'raises an error' do
+        expect { subject }.to raise_error(Gkhtmltopdf::URLSchemeInvalid, 'Invalid URL scheme: (ftp)')
       end
     end
   end

data/spec/spec_helper.rb

@@ -10,6 +10,15 @@ SimpleCov.start do
   )
 end
 
+require 'gkhtmltopdf'
+require 'tmpdir'
+require 'base64'
+module FileFixtureHelper
+  def file_fixture(filename)
+    File.join(File.expand_path('fixtures', __dir__), filename)
+  end
+end
+
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause
 # this file to always be loaded, without a need to explicitly require it in any
@@ -104,4 +113,6 @@ RSpec.configure do |config|
   #   # test failures related to randomization by passing the same `--seed` value
   #   # as the one that triggered the failure.
   #   Kernel.srand config.seed
+
+  config.include FileFixtureHelper
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gkhtmltopdf
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kazuki Sakane
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -79,14 +78,18 @@ 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
 - lib/gkhtmltopdf/converter.rb
+- lib/gkhtmltopdf/dsl.rb
 - lib/gkhtmltopdf/version.rb
 - spec/fixtures/test.html
 - spec/gkhtmltopdf/converter_spec.rb
@@ -98,6 +101,7 @@ licenses:
 metadata:
   homepage_uri: https://f6a.net/oss/
   source_code_uri: https://github.com/fantasia-tech/gkhtmltopdf-rb
+  changelog_uri: https://github.com/fantasia-tech/gkhtmltopdf-rb/blob/main/CHANGELOG.md
 post_install_message: "=====================================================================\nGkhtmltopdf
   has been installed successfully. \U0001F389\n\n⚠️ Caution\nRequired: To run this
   gem, you need to have `firefox` and `geckodriver` installed and added to your PATH.\n\ncheck
@@ -119,8 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Firefox
 - Geckodriver
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Gkhtmltopdf is mean Gecko HTML to PDF converter.
 test_files: []