gotenberg-ruby 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa54cb50c0f1acb75b9f60323e2609a58e0dfd9dc24598ea329dfeec6903e26
-  data.tar.gz: 473d60ac2f1f4b70d8c53b59032df0fafae5d86ece2d4c5fca7a1e538e93954c
+  metadata.gz: 6d5bca5c31fb41596a72235309e9ac5156d156290a8d8f961b626e49e41a896a
+  data.tar.gz: 1d2562aaef002bafbafdc1f31da3341de73271b2cb09a95f9eede6f36b76c38d
 SHA512:
-  metadata.gz: 71c2f2768d00baad5f44238fb893b721dfe768f399396a6e750f343af49339a76619095d32471a827f21ed31b5fffbbe99d79fd8b536db9bd73185c64096bf23
-  data.tar.gz: c6facaf037d8ee62c8deb870565c39a70a5897b64241cdc868147eb117715bd54b20e91b17665fb7f4424de6bf986b9e42681bccbb779e77874e8a12fd5d0911
+  metadata.gz: 4fa4fa88a317bc10f35fc9f01bcae87b14501f3fc5aeca9e67a70d3c1e433c863cfdd61fc19af4797a0a6aa16b3438542450eed7ca9a7d685f78e275ec102884
+  data.tar.gz: 88fe62bc6fbc1e8f2db20cd4a797bfca471c01e45feb6636299e427d35dd8b55cb6900677386dacb6c9c2e8221b4c628431063d7de0621ee8b36d0856036af89

data/README.md

@@ -22,6 +22,9 @@ gem "gotenberg-ruby"
 
 * [Send a request to the API](#send-a-request-to-the-api)
 * [Chromium](#chromium)
+* [LibreOffice](#libreOffice)
+* [PDF Engines](#pdf-engines)
+* [Webhook](#webhook)
 
 ### Run Gotenberg
 
@@ -125,7 +128,12 @@ gotenberg_javascript_tag 'application.js', inline: true
 gotenberg_stylesheet_tag 'application.css', inline: true
 ```
 
-⚠️ Warning! Nested resources for CSS is not supported yet.
+⚠️ Gem also supported extracting CSS nested resources defined with url() in experimentally mode.
+
+```ruby
+# skip nested resources auto extracting
+gotenberg_stylesheet_tag 'application.css', inline: true, skip_analyze: true
+```
 
 #### Convert an HTML document to PDF
 
@@ -414,10 +422,7 @@ You may add HTTP headers that Chromium will send when loading the HTML document:
 ```ruby
 document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
   doc.url 'https://my.url'
-  doc.extra_http_headers [
-    'My-Header-1' => 'My value',
-    'My-Header-2' => 'My value'
-  ]
+  doc.extra_http_headers({'My-Header-1' => 'My value', 'My-Header-2' => 'My value'})
 end
 ```
 
@@ -456,3 +461,182 @@ document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
   doc.pdf_format 'PDF/A-1a'
 end
 ```
+
+### LibreOffice
+
+The [LibreOffice module](https://gotenberg.dev/docs/modules/libreoffice) interacts with [LibreOffice](https://www.libreoffice.org/) 
+to convert documents to PDF, thanks to [unoconv](https://github.com/unoconv/unoconv).
+
+#### Convert documents to PDF
+
+See https://gotenberg.dev/docs/modules/libreoffice#route.
+
+Converting a document to PDF is as simple as:
+
+```ruby
+document = Gotenberg::Libreoffice.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.convert '/path/to/my.docx'
+end
+```
+
+If you send many documents, Gotenberg will return a ZIP archive with the PDFs:
+
+```ruby
+document = Gotenberg::Libreoffice.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.convert '/path/to/my.docx', '/path/to/my.xlsx'
+end
+
+# will return binary data with zip archive content
+File.open('archive.zip', 'wb') do |file|
+  file << document.to_binary
+end
+```
+
+You may also merge them into one unique PDF:
+
+```ruby
+document = Gotenberg::Libreoffice.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.merge
+  doc.convert '/path/to/my.docx', '/path/to/my.xlsx'
+end
+```
+
+Please note that the merging order is determined by the order of the arguments.
+
+#### Landscape orientation
+
+You may override the default portrait orientation with:
+
+```ruby
+document = Gotenberg::Libreoffice.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.landscape
+  doc.convert '/path/to/my.docx'
+end
+```
+
+#### Page ranges
+
+You may set the page ranges to print, e.g., `1-4`. Empty means all pages.
+
+```ruby
+document = Gotenberg::Libreoffice.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.native_page_ranges '1-2'
+  doc.convert '/path/to/my.docx'
+end
+```
+
+⚠️ The page ranges are applied to all files independently.
+
+#### PDF format
+
+See https://gotenberg.dev/docs/modules/pdf-engines#engines.
+
+You may set the PDF format of the resulting PDF(s) with:
+
+```ruby
+document = Gotenberg::Libreoffice.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.pdf_format 'PDF/A-1a'
+  doc.convert '/path/to/my.docx'
+end
+```
+
+You may also explicitly tell Gotenberg to use [unoconv](https://github.com/unoconv/unoconv) to convert the resulting PDF(s) to a PDF format:
+
+```ruby
+document = Gotenberg::Libreoffice.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.native_pdf_format 'PDF/A-1a'
+  doc.convert '/path/to/my.docx'
+end
+```
+
+⚠️ You cannot set both property, otherwise Gotenberg will return `400 Bad Request` response.
+
+
+### PDF Engines
+
+The [PDF Engines module](https://gotenberg.dev/docs/modules/pdf-engines) gathers all engines that can manipulate PDF files.
+
+#### Merge PDFs
+
+See https://gotenberg.dev/docs/modules/pdf-engines#merge.
+
+Merging PDFs is as simple as:
+
+```ruby
+document = Gotenberg::PdfEngines.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.merge '/path/to/my.pdf', '/path/to/my2.pdf'
+end
+```
+
+Please note that the merging order is determined by the order of the arguments.
+
+You may also set the PDF format of the resulting PDF(s) with:
+
+```ruby
+document = Gotenberg::PdfEngines.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.pdf_format 'PDF/A-1a'
+  doc.merge '/path/to/my.pdf', '/path/to/my2.pdf', '/path/to/my3.pdf'
+end
+```
+
+#### Convert to a specific PDF format
+
+See https://gotenberg.dev/docs/modules/pdf-engines#convert.
+
+You may convert a PDF to a specific PDF format with:
+
+```ruby
+document = Gotenberg::PdfEngines.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.convert 'PDF/A-1a', '/path/to/my.pdf'
+end
+```
+
+If you send many PDFs, Gotenberg will return a ZIP archive with the PDFs:
+
+```ruby
+document = Gotenberg::PdfEngines.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.convert 'PDF/A-1a', '/path/to/my.pdf', '/path/to/my2.pdf', '/path/to/my3.pdf'
+end
+
+# will return binary data with zip archive content
+File.open('archive.zip', 'wb') do |file|
+  file << document.to_binary
+end
+```
+
+### Webhook
+
+The [Webhook module](https://gotenberg.dev/docs/modules/webhook) is a Gotenberg middleware that sends the API
+responses to callbacks.
+
+⚠️ You cannot use the `document.to_binary` method if you're using the webhook feature.
+
+For instance:
+
+```ruby
+document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.url 'https://my.url'
+  doc.webhook 'https://my.webhook.url', 'https://my.webhook.error.url'
+end
+```
+
+You may also override the default HTTP method (`POST`) that Gotenberg will use to call the webhooks:
+
+```ruby
+document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.url 'https://my.url'
+  doc.webhook_method('PATCH')
+  doc.webhook_error_method('PUT')
+  doc.webhook 'https://my.webhook.url', 'https://my.webhook.error.url'
+end
+```
+
+You may also tell Gotenberg to add extra HTTP headers that it will send alongside the request to the webhooks:
+
+```ruby
+document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.url 'https://my.url'
+  doc.webhook_extra_http_headers({'My-Header-1' => 'My value', 'My-Header-2' => 'My value'})
+  doc.webhook 'https://my.webhook.url', 'https://my.webhook.error.url'
+end
+```

data/lib/gotenberg/analyzers/base.rb

@@ -1,5 +1,6 @@
-require 'faraday'
 require 'base64'
+require 'net/http'
+require 'uri'
 require 'gotenberg/exceptions'
 
 module Gotenberg
@@ -13,6 +14,10 @@ module Gotenberg
         @resource = resource
       end
 
+      def call
+        self
+      end
+
       def assets
         [binary, filename]
       end
@@ -20,25 +25,11 @@ module Gotenberg
       private
 
       def binary
-        @binary ||= remote? ? remote_source : local_source
-      end
-
-      def remote_source
-        Faraday.get(src).body
-      rescue StandardError => e
-        raise RemoteSourceError.new('Unable to load remote source. %s' % e.message)
-      end
-
-      def local_source
-        IO.binread(src)
-      end
-
-      def extension
-        @extension ||= File.extname(filename).strip.downcase[1..-1]
+        @binary ||= remote? ? remote_source(src) : local_source(src)
       end
 
       def filename
-        @filename ||= File.basename(src)
+        @filename ||= URI(File.basename(src)).path
       end
 
       def remote?
@@ -48,6 +39,16 @@ module Gotenberg
       def src
         resource[:src]
       end
+
+      def local_source path
+        IO.binread(path)
+      end
+
+      def remote_source url
+        Net::HTTP.get_response(URI(url)).body
+      rescue StandardError => e
+        raise RemoteSourceError.new('Unable to load remote source. %s' % e.message)
+      end
     end
   end
 end

data/lib/gotenberg/analyzers/css.rb

@@ -1,10 +1,17 @@
-require 'faraday'
-require 'base64'
 require 'gotenberg/analyzers/base'
+require 'gotenberg/analyzers/resource'
 
 module Gotenberg
   module Analyzers
     class Css < Base
+      ASSETS_REGEX = /url\((?!['"]?(?:data|https?):)['"]?([^'"\)]*)['"]?\)/
+
+      def call
+        analyze_binary unless resource[:skip_analyze]
+
+        self
+      end
+
       def tag
         if resource[:inline]
           '<style type="text/css">%s</style>' % binary
@@ -12,6 +19,25 @@ module Gotenberg
           '<link rel="stylesheet" href="%s" />' % filename
         end
       end
+
+      def assets
+        @assets ||= [[binary, filename]]
+      end
+
+      private
+
+      def analyze_binary
+        binary.gsub!(ASSETS_REGEX) do
+          resource_src = File.join(resource[:base_path], $1)
+
+          analyzer =
+            Analyzers::Resource.new(resource.merge(src: resource_src)).call
+
+          assets << analyzer.assets
+
+          analyzer.tag
+        end
+      end
     end
   end
 end

data/lib/gotenberg/analyzers/image.rb

@@ -1,23 +1,9 @@
-require 'faraday'
-require 'base64'
 require 'gotenberg/analyzers/base'
+require 'gotenberg/utilities/inline_resource'
 
 module Gotenberg
   module Analyzers
     class Image < Base
-      MIME_TYPES = {
-        'bmp' => 'image/bmp',
-        'gif' => 'image/gif',
-        'jpe' => 'image/jpeg',
-        'jpeg' => 'image/jpeg',
-        'jpg' => 'image/jpeg',
-        'jfif' => 'image/pipeg',
-        'svg' => 'image/svg+xml',
-        'tif' => 'image/tiff',
-        'tiff' => 'image/tiff',
-        'ico' => 'image/x-icon'
-      }.freeze
-
       def tag
         '<img src="%s" alt="%s" />' % [src_value, filename]
       end
@@ -26,15 +12,11 @@ module Gotenberg
 
       def src_value
         if resource[:inline]
-          'data:%s;base64,%s' % [mimetype, Base64.strict_encode64(binary)]
+          Gotenberg::Utilities::InlineResource.new(filename, binary).call
         else
           filename
         end
       end
-
-      def mimetype
-        MIME_TYPES[extension] || 'application/octet-stream'
-      end
     end
   end
 end

data/lib/gotenberg/analyzers/js.rb

@@ -1,4 +1,3 @@
-require 'faraday'
 require 'base64'
 require 'gotenberg/analyzers/base'
 

data/lib/gotenberg/analyzers/resource.rb

@@ -0,0 +1,22 @@
+require 'gotenberg/analyzers/base'
+require 'gotenberg/utilities/inline_resource'
+
+module Gotenberg
+  module Analyzers
+    class Resource < Base
+      def tag
+        'url(%s)' % src_value
+      end
+
+      private
+
+      def src_value
+        if resource[:inline]
+          Gotenberg::Utilities::InlineResource.new(filename, binary).call
+        else
+          filename
+        end
+      end
+    end
+  end
+end

data/lib/gotenberg/chromium/files.rb

@@ -11,6 +11,8 @@ module Gotenberg
         compiler = Compiler.new(header)
 
         files << multipart_file(compiler.body, 'header.html', 'text/html')
+
+        self
       end
 
       # Adds a footer to each page.
@@ -19,6 +21,8 @@ module Gotenberg
         compiler = Compiler.new(footer)
 
         files << multipart_file(compiler.body, 'footer.html', 'text/html')
+
+        self
       end
 
       # Converts an HTML document to PDF.
@@ -70,12 +74,12 @@ module Gotenberg
         self
       end
 
+      private
+
       def files
         @files ||= []
       end
 
-      private
-
       def multipart_file body, filename, content_type = 'application/octet-stream'
         Faraday::Multipart::FilePart.new(StringIO.new(body), content_type, filename)
       end

data/lib/gotenberg/chromium/properties.rb

@@ -133,6 +133,8 @@ module Gotenberg
 
         self
       end
+
+      private
  
       def properties
         @properties ||= {}

data/lib/gotenberg/chromium.rb

@@ -1,7 +1,7 @@
 require 'gotenberg/chromium/properties'
 require 'gotenberg/chromium/files'
-require 'gotenberg/chromium/headers'
-require 'gotenberg/chromium/metadata'
+require 'gotenberg/headers'
+require 'gotenberg/metadata'
 require 'gotenberg/client'
 require 'gotenberg/exiftools'
 require 'gotenberg/extractors'
@@ -30,10 +30,7 @@ module Gotenberg
     def call
       backtrace if html_debug?
       transform
-
-      if success? && metadata_available? 
-        modify_metadata
-      end
+      modify_metadata if modify_metadata?
 
       self
     end
@@ -46,12 +43,19 @@ module Gotenberg
       response || raise(exception)
     end
 
+
+    private
+
+    def modify_metadata?
+      return false if webhook_request?
+
+      success? && metadata_available?
+    end
+
     def html_debug?
       Gotenberg.configuration.html_debug == true
     end
 
-    private
-
     def backtrace
       Backtrace.new(files).call
     end

data/lib/gotenberg/compiler.rb

@@ -30,26 +30,16 @@ module Gotenberg
         analyzer = 
           case resource[:tag]
           when 'image'
-            Analyzers::Image.new(resource)
+            Analyzers::Image.new(resource).call
           when 'js'
-            Analyzers::Js.new(resource)
+            Analyzers::Js.new(resource).call
           when 'css'
-            Analyzers::Css.new(resource)
+            Analyzers::Css.new(resource).call
           end
 
-        assets << analyzer.assets
+        assets.push(*analyzer.assets)
 
         analyzer.tag
-
-        #css - 
-        #  1) read to io (http or file)
-        #  2) scan for url tags -
-        #    if data - skip
-        #    if relative (read to io http or file )
-        #    replace url tags
-        #  3) check if inline then stylesheet tag
-        #  4) if not inline add to assets
-        #  5) replace tag
       end
     end
   end

data/lib/gotenberg/headers.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module Gotenberg
+  module Headers
+    # Sets the callback and error callback that Gotenberg will use to send
+    # respectively the output file and the error response.
+    def webhook url, error_url
+      headers['Gotenberg-Webhook-Url'] = url
+      headers['Gotenberg-Webhook-Error-Url'] = error_url
+
+      self
+    end
+
+    # Overrides the default HTTP method that Gotenberg will use to call the webhook.
+    # Either "POST", "PATCH", or "PUT" - default "POST".
+    def webhook_method method
+      headers['Gotenberg-Webhook-Method'] = method
+
+      self
+    end
+
+    # Overrides the default HTTP method that Gotenberg will use to call the error webhook.
+    # Either "POST", "PATCH", or "PUT" - default "POST".
+    def webhook_error_method method
+      headers['Gotenberg-Webhook-Error-Method'] = method
+
+      self
+    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
+
+      self
+    end
+
+    # Overrides the default UUID trace, or request ID, that identifies a request in Gotenberg's logs.
+    def trace trace, header = 'Gotenberg-Trace'
+      headers[header] = trace
+
+      self
+    end
+
+    private
+
+    def webhook_request?
+      headers.keys.include?('Gotenberg-Webhook-Url')
+    end
+
+    def headers
+      @headers ||= {}
+    end
+  end
+end

data/lib/gotenberg/helpers/action_view.rb

@@ -2,36 +2,68 @@ module Gotenberg
   module Helpers
     module ActionView
       def gotenberg_image_tag source, options = {}
-        gootenberg_source_tag(source, options.merge(tag: 'image'))
+        options[:tag] = 'image'
+        options[:src] = gotenberg_source_location(source, options)
+
+        gotenberg_context_tag(options)
       end
 
       def gotenberg_javascript_tag source, options = {}
-        gootenberg_source_tag(source, options.merge(tag: 'js'))
+        options[:tag] = 'js'
+        options[:src] = gotenberg_source_location(source, options)
+
+        gotenberg_context_tag(options)
       end
 
       def gotenberg_stylesheet_tag source, options = {}
-        gootenberg_source_tag(source, options.merge(tag: 'css'))
+        options[:tag] = 'css'
+        options[:src] = gotenberg_source_location(source, options)
+
+        options[:base_path] =
+          case gotenberg_source_type(options)
+          when :absolute
+            Rails.root
+          when :proxy
+            compute_asset_host(source, protocol: :request)
+          when :static
+            Rails.public_path
+          end
+
+        options[:skip_analyze] ||= false
+
+        gotenberg_context_tag(options)
       end
 
       private
 
-      def gootenberg_source_tag source, options = {}
-        src = if options[:absolute_path]
-          File.join(Rails.root, source)
-        elsif Rails.env.development?
-          gootenberg_asset_location(source, :url)
-        else
-          File.join(Rails.public_path, gootenberg_asset_location(source, :path))
+      def gotenberg_source_type options = {}
+        return :absolute if options[:absolute_path]
+
+        if Rails.application.config.asset_host || Rails.application.config.action_controller.asset_host
+          raise <<-EOF.squish
+              You can not use Gotenberg tag helpers for assets with "asset_host" option. Use standard rails assets tag helpers.
+            EOF
         end
 
-        gootenberg_context_tag(src: src, **options)
+        Rails.env.development? ? :proxy : :static
+      end
+
+      def gotenberg_source_location source, options = {}
+        case gotenberg_source_type(options)
+        when :absolute
+          File.join(Rails.root, source)
+        when :proxy
+          gotenberg_asset_location(source, :url)
+        when :static
+          File.join(Rails.public_path, gotenberg_asset_location(source, :path))
+        end
       end
 
-      def gootenberg_context_tag attributes
+      def gotenberg_context_tag attributes
         ('<!-- GOTENBERG-CONTEXT-TAG %s -->' % attributes.to_json).html_safe 
       end
 
-      def gootenberg_asset_location source, type
+      def gotenberg_asset_location source, type
         webpacker = Module.const_defined?(:Webpacker)
 
         case type

data/lib/gotenberg/libreoffice/files.rb

@@ -0,0 +1,42 @@
+require 'faraday'
+require 'faraday/multipart'
+require 'gotenberg/utilities/index'
+
+module Gotenberg
+  class Libreoffice
+    module Files
+
+     # Converts the given document(s) to PDF(s).
+     # Gotenberg will return either a unique PDF if you request a merge or a ZIP archive with the PDFs.
+     # Note: if you requested a merge, the merging order is determined by the order of the arguments.
+     # See https://gotenberg.dev/docs/modules/libreoffice#route.
+      def convert *sources
+        sources.each.with_index(1) do |source, index|
+          files << multipart_file(IO.binread(source), merge_prefix(index) + File.basename(source))
+        end
+
+        @endpoint = '/forms/libreoffice/convert'
+
+        self
+      end
+
+      private
+
+      def files
+        @files ||= []
+      end
+
+      def zip_mode?
+        properties['merge'] != true && files.size > 1
+      end
+
+      def merge_prefix number
+        properties['merge'] ? Gotenberg::Utilities::Index::to_alpha(number) + '_' : ''
+      end
+
+      def multipart_file body, filename, content_type = 'application/octet-stream'
+        Faraday::Multipart::FilePart.new(StringIO.new(body), content_type, filename)
+      end
+    end
+  end
+end

data/lib/gotenberg/libreoffice/properties.rb

@@ -0,0 +1,49 @@
+module Gotenberg
+  class Libreoffice
+    module Properties
+
+      # Sets the paper orientation to landscape.
+      def landscape
+        properties['landscape'] = true
+
+        self
+      end
+
+      # Set the page ranges to print, e.g., "1-5, 8, 11-13". Empty means all pages.
+      # Note: the page ranges are applied to all files independently.
+      def native_page_ranges ranges
+        properties['nativePageRanges'] = ranges
+
+        self
+      end
+
+      # Tells Gotenberg to use unoconv for converting the resulting PDF to a PDF format.
+      def native_pdf_format format
+        properties['nativePdfFormat'] = format
+
+        self
+      end
+
+      # Sets the PDF format of the resulting PDF.
+      # See https://gotenberg.dev/docs/modules/pdf-engines#engines.
+      def pdf_format format
+        properties['pdfFormat'] = format
+
+        self
+      end
+
+      # Merges the resulting PDFs.
+      def merge
+        properties['merge'] = true
+
+        self
+      end
+
+      private
+
+      def properties
+        @properties ||= {}
+      end
+    end
+  end
+end

data/lib/gotenberg/libreoffice.rb

@@ -0,0 +1,68 @@
+require 'gotenberg/libreoffice/properties'
+require 'gotenberg/libreoffice/files'
+require 'gotenberg/headers'
+require 'gotenberg/metadata'
+require 'gotenberg/client'
+require 'gotenberg/exiftools'
+require 'gotenberg/exceptions'
+
+module Gotenberg
+  class Libreoffice
+    include Properties, Files, Headers, Metadata
+
+    attr_accessor :base_path
+    attr_reader :endpoint, :response, :exception
+    
+    def self.call(base_path, &block)
+      new(base_path: base_path, &block).call
+    end
+
+    def initialize args
+      args.each do |key, value|
+        public_send(('%s=' % key), value)
+      end
+
+      yield self if block_given?
+    end
+
+    def call
+      transform
+      modify_metadata if modify_metadata?
+
+      self
+    end
+
+    def success?
+      exception == nil
+    end
+
+    def to_binary
+      response || raise(exception)
+    end
+
+    private
+
+    def modify_metadata?
+      return false if webhook_request?
+      return false if zip_mode?
+
+      success? && metadata_available?
+    end
+
+    def transform
+      @response = client.adapter.post(endpoint, properties.merge(files: files), headers).body
+    rescue StandardError => e
+      @exception = Gotenberg::TransformError.new(e)
+    end
+
+    def modify_metadata
+      @response = Exiftools.modify(response, metadata)
+    rescue StandardError => e
+      @exception = Gotenberg::ModifyMetadataError.new(e)
+    end
+
+    def client
+      Client.new(base_path)
+    end
+  end
+end

data/lib/gotenberg/metadata.rb

@@ -0,0 +1,20 @@
+module Gotenberg
+  module Metadata
+    # set meta headers for PDF file with exiftools (title, creator, etc...)
+    def meta elements
+      metadata.merge!(elements)
+
+      self
+    end
+
+    private
+
+    def metadata_available?
+      !metadata.empty?
+    end
+
+    def metadata
+      @metadata ||= {}
+    end
+  end
+end

data/lib/gotenberg/pdf_engines/files.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+require 'faraday/multipart'
+require 'gotenberg/utilities/index'
+
+module Gotenberg
+  class PdfEngines
+    module Files
+
+      # Merges PDFs into a unique PDF.
+      # Note: the merging order is determined by the order of the arguments.
+      # See https://gotenberg.dev/docs/modules/pdf-engines#merge.
+      def merge *sources
+        sources.each.with_index(1) do |source, index|
+          files << multipart_file(IO.binread(source), merge_prefix(index) + File.basename(source))
+        end
+
+        @endpoint = '/forms/pdfengines/merge'
+
+        self
+      end
+
+      # Converts PDF(s) to a specific PDF format.
+      # Gotenberg will return the PDF or a ZIP archive with the PDFs.
+      # https://gotenberg.dev/docs/modules/pdf-engines#convert.
+      # https://gotenberg.dev/docs/modules/pdf-engines#engines.
+      def convert format, *sources
+        properties['pdfFormat'] = format
+
+        sources.each.with_index(1) do |source, index|
+          files << multipart_file(IO.binread(source), File.basename(source))
+        end
+
+        @endpoint = '/forms/pdfengines/convert'
+        @pdf_engines_convert = true
+
+        self
+      end
+
+      private
+
+      def files
+        @files ||= []
+      end
+
+      def zip_mode?
+        @pdf_engines_convert && files.size > 1
+      end
+
+      def merge_prefix number
+        Gotenberg::Utilities::Index::to_alpha(number) + '_'
+      end
+
+      def multipart_file body, filename, content_type = 'application/octet-stream'
+        Faraday::Multipart::FilePart.new(StringIO.new(body), content_type, filename)
+      end
+    end
+  end
+end

data/lib/gotenberg/pdf_engines/properties.rb

@@ -0,0 +1,20 @@
+module Gotenberg
+  class PdfEngines
+    module Properties
+
+      # Sets the PDF format of the resulting PDF.
+      # See https://gotenberg.dev/docs/modules/pdf-engines#engines.
+      def pdf_format format
+        properties['pdfFormat'] = format
+
+        self
+      end
+
+      private
+
+      def properties
+        @properties ||= {}
+      end
+    end
+  end
+end

data/lib/gotenberg/pdf_engines.rb

@@ -0,0 +1,67 @@
+require 'gotenberg/pdf_engines/properties'
+require 'gotenberg/pdf_engines/files'
+require 'gotenberg/headers'
+require 'gotenberg/metadata'
+require 'gotenberg/client'
+require 'gotenberg/exiftools'
+require 'gotenberg/exceptions'
+
+module Gotenberg
+  class PdfEngines
+    include Properties, Files, Headers, Metadata
+
+    attr_accessor :base_path
+    attr_reader :endpoint, :response, :exception
+    
+    def self.call(base_path, &block)
+      new(base_path: base_path, &block).call
+    end
+
+    def initialize args
+      args.each do |key, value|
+        public_send(('%s=' % key), value)
+      end
+
+      yield self if block_given?
+    end
+
+    def call
+      transform
+      modify_metadata if modify_metadata?
+
+      self
+    end
+
+    def success?
+      exception == nil
+    end
+
+    def to_binary
+      response || raise(exception)
+    end
+
+    private
+
+    def modify_metadata?
+      return false if webhook_request?
+
+      success? && metadata_available?
+    end
+
+    def transform
+      @response = client.adapter.post(endpoint, properties.merge(files: files), headers).body
+    rescue StandardError => e
+      @exception = Gotenberg::TransformError.new(e)
+    end
+
+    def modify_metadata
+      @response = Exiftools.modify(response, metadata)
+    rescue StandardError => e
+      @exception = Gotenberg::ModifyMetadataError.new(e)
+    end
+
+    def client
+      Client.new(base_path)
+    end
+  end
+end

data/lib/gotenberg/utilities/index.rb

@@ -0,0 +1,17 @@
+module Gotenberg
+  module Utilities
+    class Index
+      def self.to_alpha index, alpha = ''
+        return '' if index <= 0
+
+        until index.zero?
+          pointer = (index - 1) % 26
+          index = ((index - pointer) / 26).to_i
+          alpha = (65 + pointer).chr + alpha
+        end
+        
+        alpha
+      end
+    end
+  end
+end

data/lib/gotenberg/utilities/inline_resource.rb

@@ -0,0 +1,47 @@
+require 'base64'
+
+module Gotenberg
+  module Utilities
+    class InlineResource
+      MIME_TYPES = {
+        'bmp' => 'image/bmp',
+        'gif' => 'image/gif',
+        'png' => 'image/png',
+        'jpe' => 'image/jpeg',
+        'jpeg' => 'image/jpeg',
+        'jpg' => 'image/jpeg',
+        'jfif' => 'image/pipeg',
+        'svg' => 'image/svg+xml',
+        'tif' => 'image/tiff',
+        'tiff' => 'image/tiff',
+        'ico' => 'image/x-icon',
+        'eot' => 'application/vnd.ms-fontobject',
+        'otf' => 'application/font-sfnt',
+        'ttf' => 'application/font-sfnt',
+        'woff' => 'application/font-woff',
+        'woff2' => 'application/font-woff2',
+      }.freeze
+
+      attr_reader :filename, :binary
+
+      def initialize filename, binary
+        @filename = filename
+        @binary = binary
+      end
+
+      def call
+        'data:%s;base64,%s' % [mimetype, Base64.strict_encode64(binary)]
+      end
+
+      private
+
+      def extension
+        @extension ||= File.extname(filename).downcase[1..-1]
+      end
+
+      def mimetype
+        @mimetype ||= MIME_TYPES[extension] || 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/gotenberg/version.rb

@@ -1,3 +1,3 @@
 module Gotenberg
-  VERSION = '1.0.4'
+  VERSION = '1.0.6'
 end

data/lib/gotenberg-ruby.rb

@@ -3,6 +3,8 @@ require 'gotenberg/railtie' if defined?(Rails::Railtie)
 
 module Gotenberg
   autoload :Chromium, 'gotenberg/chromium'
+  autoload :Libreoffice, 'gotenberg/libreoffice'
+  autoload :PdfEngines, 'gotenberg/pdf_engines'
   autoload :Configuration, 'gotenberg/configuration'
 
   def self.configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gotenberg-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - sanzstez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,11 +87,10 @@ files:
 - lib/gotenberg/analyzers/css.rb
 - lib/gotenberg/analyzers/image.rb
 - lib/gotenberg/analyzers/js.rb
+- lib/gotenberg/analyzers/resource.rb
 - lib/gotenberg/backtrace.rb
 - lib/gotenberg/chromium.rb
 - lib/gotenberg/chromium/files.rb
-- lib/gotenberg/chromium/headers.rb
-- lib/gotenberg/chromium/metadata.rb
 - lib/gotenberg/chromium/properties.rb
 - lib/gotenberg/client.rb
 - lib/gotenberg/compiler.rb
@@ -99,8 +98,18 @@ files:
 - lib/gotenberg/exceptions.rb
 - lib/gotenberg/exiftools.rb
 - lib/gotenberg/extractors.rb
+- lib/gotenberg/headers.rb
 - lib/gotenberg/helpers/action_view.rb
+- lib/gotenberg/libreoffice.rb
+- lib/gotenberg/libreoffice/files.rb
+- lib/gotenberg/libreoffice/properties.rb
+- lib/gotenberg/metadata.rb
+- lib/gotenberg/pdf_engines.rb
+- lib/gotenberg/pdf_engines/files.rb
+- lib/gotenberg/pdf_engines/properties.rb
 - lib/gotenberg/railtie.rb
+- lib/gotenberg/utilities/index.rb
+- lib/gotenberg/utilities/inline_resource.rb
 - lib/gotenberg/version.rb
 homepage: https://github.com/sanzstez/gotenberg-ruby
 licenses:

data/lib/gotenberg/chromium/headers.rb

@@ -1,50 +0,0 @@
-require 'json'
-
-module Gotenberg
-  class Chromium
-    module Headers
-      # Sets the callback and error callback that Gotenberg will use to send
-      # respectively the output file and the error response.
-      def webhook url, error_url
-        headers['Gotenberg-Webhook-Url'] = url
-        headers['Gotenberg-Webhook-Error-Url'] = error_url
-
-        self
-      end
- 
-      # Overrides the default HTTP method that Gotenberg will use to call the webhook.
-      # Either "POST", "PATCH", or "PUT" - default "POST".
-      def webhook_method method
-        headers['Gotenberg-Webhook-Method'] = method
-
-        self
-      end
- 
-      # Overrides the default HTTP method that Gotenberg will use to call the error webhook.
-      # Either "POST", "PATCH", or "PUT" - default "POST".
-      def webhook_error_method method
-        headers['Gotenberg-Webhook-Error-Method'] = method
-
-        self
-      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
-
-        self
-      end
-
-      # Overrides the default UUID trace, or request ID, that identifies a request in Gotenberg's logs.
-      def trace trace, header = 'Gotenberg-Trace'
-        headers[header] = trace
-
-        self
-      end
-
-      def headers
-        @headers = {}
-      end
-    end
-  end
-end

data/lib/gotenberg/chromium/metadata.rb

@@ -1,24 +0,0 @@
-require 'json'
-
-module Gotenberg
-  class Chromium
-    module Metadata
-      # set meta headers for PDF file with exiftools (title, creator, etc...)
-      def meta elements
-        metadata.merge!(elements)
-
-        self
-      end
-
-      def metadata_available?
-        !metadata.empty?
-      end
-
-      private
-
-      def metadata
-        @metadata ||= {}
-      end
-    end
-  end
-end