gotenberg-ruby 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 476cd73562dd16cf55f0b443e9eced1cddae4d5bd805c362142897cefc9c3bb1
-  data.tar.gz: c9be491d408f741d607b976856ad6cad15a0239730fac64877e39c27615e3568
+  metadata.gz: 88445f0f58092b9e2d6be42c5cc98a7a89e26690308b11d61b58335f843882c0
+  data.tar.gz: cf50d4938b42a7684d57a377e06743e599a0a3224da06d073a17aeeaee203d87
 SHA512:
-  metadata.gz: 9891c2078d680a9e4bee73f1fc054e8c0e43b2d0631846b5ecacbd1080994eed1dc355ee54a139ad8de36985794985f2a7638a27501ce4724147116962a905db
-  data.tar.gz: dfdad56ef10d4d1b009ad2625bb7cce4043f7e50fc5ca64c4ca6e59d43e46797831913739e99128f6276c9f813239b194c54b358f4ea26602583d81210ac55f4
+  metadata.gz: 6cc1b8b2e3ef620d6bf6d3468ad65e3f005cbd86d6f658ea908b7acfb4ef584e5f72c85f0f0ffdc22cb39d974d9fa2f9484c087c24154ae88cb80561e32b6e1e
+  data.tar.gz: 44db5856d4e4ca62396296a968d69dde66f547e5e98a012f0ea1061c254ca2a4525ad36b3007c6d5e8dd47e7ab11ea9d7feea924edc9be738db123043b915197

data/README.md

@@ -36,7 +36,7 @@ version: "3"
 
 services:
   gotenberg:
-    image: gotenberg/gotenberg:7
+    image: gotenberg/gotenberg:8
     restart: always
     ports:
       - 3000:3000
@@ -85,6 +85,14 @@ File.open('filename.pdf', 'wb') do |file|
 end
 ```
 
+Pass additional headers for faraday client instance (Authorization, User-Agent, etc.):
+
+```ruby
+document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL'], headers: { 'Authorization': 'Bearer token123' }) do |doc|
+  doc.url 'https://my.url'
+end
+```
+
 Available exceptions:
 
 ```ruby
@@ -385,7 +393,7 @@ The following classes allow you to inject printing values:
 * No JavaScript.
 * The CSS properties are independent of the ones from the HTML document.
 * The footer CSS properties override the ones from the header;
-* Only fonts installed in the Docker image are loaded - see the [Fonts chapter](https://gotenberg.dev/docs/customize/fonts).
+* Only fonts installed in the Docker image are loaded - see the [Fonts chapter](https://gotenberg.dev/docs/configuration#fonts).
 * Images only work using a base64 encoded source - i.e., `data:image/png;base64, iVBORw0K....`
 * `background-color` and color `CSS` properties require an additional `-webkit-print-color-adjust: exact` CSS property in order to work.
 * Assets are not loaded (i.e., CSS files, scripts, fonts, etc.).
@@ -435,6 +443,17 @@ document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
 end
 ```
 
+#### Client Extra HTTP headers
+
+This method just duplicate way of passing headers into faraday client. Have same purpose:
+
+```ruby
+document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.url 'https://my.url'
+  doc.client_extra_http_headers({ 'Authorization': 'Bearer token123' })
+end
+```
+
 #### Fail on console exceptions
 
 You may force Gotenberg to return a `409 Conflict` response if there are exceptions in the Chromium console:

data/lib/gotenberg/chromium/properties.rb

@@ -83,7 +83,7 @@ module Gotenberg
         self
       end
  
-      # Overrides the default "User-Agent" header.
+      # DEPRECATED in Gotenberg 8. Overrides the default "User-Agent" header.
       def user_agent user_agent
         properties['userAgent'] = user_agent
 
@@ -92,7 +92,7 @@ module Gotenberg
 
       # Sets extra HTTP headers that Chromium will send when loading the HTML document.
       def extra_http_headers headers
-        properties['userAgent'] = headers.to_json
+        properties['extraHttpHeaders'] = headers.to_json
 
         self
       end

data/lib/gotenberg/chromium.rb

@@ -13,11 +13,11 @@ module Gotenberg
   class Chromium
     include Properties, Files, Headers, Metadata, Tools, Extractors
 
-    attr_accessor :base_path
+    attr_accessor :base_path, :client_headers
     attr_reader :endpoint, :response, :exception
     
-    def self.call(base_path, &block)
-      new(base_path: base_path, &block).call
+    def self.call(base_path, headers: {}, &block)
+      new(base_path: base_path, client_headers: headers, &block).call
     end
 
     def initialize args
@@ -73,7 +73,7 @@ module Gotenberg
     end
 
     def client
-      Client.new(base_path)
+      Client.new(base_path, headers: client_headers)
     end
   end
 end

data/lib/gotenberg/client.rb

@@ -3,10 +3,11 @@ require 'faraday/multipart'
 
 module Gotenberg
   class Client
-    attr_reader :base_path
+    attr_reader :base_path, :headers
 
-    def initialize base_path
+    def initialize base_path, headers: {}
       @base_path = base_path
+      @headers = headers
     end
 
     def adapter
@@ -19,7 +20,7 @@ module Gotenberg
     end
 
     def default_headers
-      {'Content-Type' => 'multipart/form-data'}
+      {'Content-Type' => 'multipart/form-data'}.merge(headers)
     end
   end
 end

data/lib/gotenberg/headers.rb

@@ -28,8 +28,8 @@ module Gotenberg
     end
 
     # Sets the extra HTTP headers that Gotenberg will send alongside the request to the webhook and error webhook.
-    def webhook_extra_http_headers headers
-      headers['Gotenberg-Webhook-Extra-Http-Headers'] = headers.to_json
+    def webhook_extra_http_headers extra_headers
+      headers['Gotenberg-Webhook-Extra-Http-Headers'] = extra_headers.to_json
 
       self
     end
@@ -41,6 +41,13 @@ module Gotenberg
       self
     end
 
+    # Sets the extra HTTP headers for faraday client to make request to gotenberg instance
+    def client_extra_http_headers extra_headers
+      headers.merge!(extra_headers)
+
+      self
+    end
+
     private
 
     def webhook_request?

data/lib/gotenberg/libreoffice.rb

@@ -11,11 +11,11 @@ module Gotenberg
   class Libreoffice
     include Properties, Files, Headers, Metadata, Tools
 
-    attr_accessor :base_path
+    attr_accessor :base_path, :client_headers
     attr_reader :endpoint, :response, :exception
     
-    def self.call(base_path, &block)
-      new(base_path: base_path, &block).call
+    def self.call(base_path, headers: {}, &block)
+      new(base_path: base_path, client_headers: headers, &block).call
     end
 
     def initialize args
@@ -63,7 +63,7 @@ module Gotenberg
     end
 
     def client
-      Client.new(base_path)
+      Client.new(base_path, headers: client_headers)
     end
   end
 end

data/lib/gotenberg/pdf_engines.rb

@@ -11,11 +11,11 @@ module Gotenberg
   class PdfEngines
     include Properties, Files, Headers, Metadata, Tools
 
-    attr_accessor :base_path
+    attr_accessor :base_path, :client_headers
     attr_reader :endpoint, :response, :exception
     
-    def self.call(base_path, &block)
-      new(base_path: base_path, &block).call
+    def self.call(base_path, headers: {}, &block)
+      new(base_path: base_path, client_headers: headers, &block).call
     end
 
     def initialize args
@@ -62,7 +62,7 @@ module Gotenberg
     end
 
     def client
-      Client.new(base_path)
+      Client.new(base_path, headers: client_headers)
     end
   end
 end

data/lib/gotenberg/version.rb

@@ -1,3 +1,3 @@
 module Gotenberg
-  VERSION = '1.0.11'
+  VERSION = '1.0.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gotenberg-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - sanzstez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2024-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,9 +59,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,9 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 description: A gem that provides a client interface for the Gotenberg PDF generate
   service
 email:
@@ -131,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A gem that provides a client interface for the Gotenberg PDF generate service