gotenberg-ruby 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d5bca5c31fb41596a72235309e9ac5156d156290a8d8f961b626e49e41a896a
-  data.tar.gz: 1d2562aaef002bafbafdc1f31da3341de73271b2cb09a95f9eede6f36b76c38d
+  metadata.gz: bf64c508e70367b7dadec2eee14b54218989131a240da2d927b5ba15ad6c4af6
+  data.tar.gz: a703924073bf1e819413e1e12e8b7e4e3176f9ad54ae28c47c5913cf6c9fd723
 SHA512:
-  metadata.gz: 4fa4fa88a317bc10f35fc9f01bcae87b14501f3fc5aeca9e67a70d3c1e433c863cfdd61fc19af4797a0a6aa16b3438542450eed7ca9a7d685f78e275ec102884
-  data.tar.gz: 88fe62bc6fbc1e8f2db20cd4a797bfca471c01e45feb6636299e427d35dd8b55cb6900677386dacb6c9c2e8221b4c628431063d7de0621ee8b36d0856036af89
+  metadata.gz: 1ab5c3057c04f1db12300e8de19878df41f9d9fd1414d68fd79ce6daba0fe106ce547a600fa64650ac98fc6e0e1d5100231c7ed11474072f3f439b0b5d7b01b2
+  data.tar.gz: e02a364aa9f05af5d624a5fe9926b8b12ef7d7f774dc4ae236a3833c3de3be9fb3d324d8e8f035bedb11446fbbe8fcec519a99cfcda69e09624ac2c81d34accc

data/README.md

@@ -25,6 +25,7 @@ gem "gotenberg-ruby"
 * [LibreOffice](#libreOffice)
 * [PDF Engines](#pdf-engines)
 * [Webhook](#webhook)
+* [Exiftools](#exiftools)
 
 ### Run Gotenberg
 
@@ -163,7 +164,7 @@ in the HTML DOM are on the root level.
 ```ruby
 document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
   doc.html index_html
-  doc.assets ['/path/to/my.css', '/path/to/my.js']
+  doc.assets '/path/to/my.css', '/path/to/my.js', ['<binary string>', 'my.png']
 end
 ```
 
@@ -207,7 +208,15 @@ You may convert markdown files with:
 
 ```ruby
 document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
-  doc.markdown wrapper_html, ['/path/to/file.md']
+  doc.markdown wrapper_html, '/path/to/file.md'
+end
+```
+
+Or with raw input:
+
+```ruby
+document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
+  doc.markdown wrapper_html, ['<binary data>', 'file.md']
 end
 ```
 
@@ -233,8 +242,8 @@ requirement is that their paths in the HTML DOM are on the root level.
 
 ```ruby
 document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
-  doc.markdown wrapper_html, ['/path/to/file.md', '/path/to/my2.md']
-  doc.assets ['/path/to/my.css', '/path/to/my.js']
+  doc.markdown wrapper_html, '/path/to/file.md'
+  doc.assets '/path/to/my.css', '/path/to/my.js', '/path/to/my2.md', ['<binary data>', 'file_2.md']
 end
 ```
 
@@ -483,7 +492,7 @@ 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'
+  doc.convert '/path/to/my.docx', '/path/to/my.xlsx', ['<binary data>', 'some.odt']
 end
 
 # will return binary data with zip archive content
@@ -497,7 +506,7 @@ 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'
+  doc.convert '/path/to/my.docx', '/path/to/my.xlsx', ['<binary data>', 'some.odt']
 end
 ```
 
@@ -564,7 +573,7 @@ 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'
+  doc.merge '/path/to/my.pdf', '/path/to/my2.pdf', ['<binary data>', 'some.pdf']
 end
 ```
 
@@ -587,7 +596,7 @@ 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'
+  doc.convert '/path/to/my.pdf', format: 'PDF/A-1a'
 end
 ```
 
@@ -595,7 +604,7 @@ 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'
+  doc.convert '/path/to/my.pdf', '/path/to/my2.pdf', '/path/to/my3.pdf', ['<binary data>', 'some.pdf'], format: 'PDF/A-1a'
 end
 
 # will return binary data with zip archive content
@@ -640,3 +649,19 @@ document = Gotenberg::Chromium.call(ENV['GOTENBERG_URL']) do |doc|
   doc.webhook 'https://my.webhook.url', 'https://my.webhook.error.url'
 end
 ```
+
+### Exiftools
+
+Gem also proxify (expert mode) access to mini_exiftools througth *Gotenberg::Exiftools* class.
+You can change PDF metadata manually:
+
+```ruby
+binary = Gotenberg::Exiftools.modify(pdf_binary, { title: 'Document 1' })
+
+# save PDF file
+File.open('filename.pdf', 'wb') do |file|
+  file << binary
+end
+```
+
+⚠️ Class is just wrapper around *MiniExiftool* class, so you need handle exceptions manually/carefully in begin/rescue block.

data/lib/gotenberg/chromium/{files.rb → tools.rb}

@@ -1,10 +1,8 @@
-require 'faraday'
-require 'faraday/multipart'
 require 'gotenberg/compiler'
 
 module Gotenberg
   class Chromium
-    module Files
+    module Tools
       # Adds a header to each page.
       # Note: it automatically sets the filename to "header.html", as required by Gotenberg.
       def header header
@@ -35,7 +33,7 @@ module Gotenberg
 
         files << multipart_file(compiler.body, 'index.html', 'text/html')
 
-        binary_assets(compiler.assets)
+        assets *compiler.assets
 
         @endpoint = '/forms/chromium/convert/html'
 
@@ -45,44 +43,22 @@ module Gotenberg
       # Converts one or more markdown files to PDF.
       # Note: it automatically sets the index filename to "index.html", as required by Gotenberg.
       # See https://gotenberg.dev/docs/modules/chromium#markdown.
-      def markdown index, markdowns = []
+      def markdown index, markdown
         files << multipart_file(index, 'index.html', 'text/html')
+        files << multipart_file(*load_file_from_source(markdown), 'text/markdown')
 
-        markdowns.each do |f|
-          files << multipart_file(IO.binread(f), File.basename(f), 'text/markdown')
-        end
-        
         @endpoint = '/forms/chromium/convert/markdown'
 
         self
       end
 
-      # Sets the additional files, like images, fonts, stylesheets, and so on.
-      def binary_assets sources
-        sources.each do |(io, filename)|
-          files << multipart_file(io, filename)
-        end
-
-        self
-      end
-
-      def assets sources
-        sources.each do |f|
-          files << multipart_file(IO.binread(f), File.basename(f))
+      def assets *sources
+        sources.each do |source|
+          files << multipart_file(*load_file_from_source(source))
         end
 
         self
       end
-
-      private
-
-      def files
-        @files ||= []
-      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/chromium.rb

@@ -1,7 +1,8 @@
 require 'gotenberg/chromium/properties'
-require 'gotenberg/chromium/files'
+require 'gotenberg/chromium/tools'
 require 'gotenberg/headers'
 require 'gotenberg/metadata'
+require 'gotenberg/files'
 require 'gotenberg/client'
 require 'gotenberg/exiftools'
 require 'gotenberg/extractors'
@@ -10,7 +11,7 @@ require 'gotenberg/backtrace'
 
 module Gotenberg
   class Chromium
-    include Properties, Files, Headers, Metadata, Extractors
+    include Properties, Files, Headers, Metadata, Tools, Extractors
 
     attr_accessor :base_path
     attr_reader :endpoint, :response, :exception
@@ -32,6 +33,8 @@ module Gotenberg
       transform
       modify_metadata if modify_metadata?
 
+      puts files.inspect
+
       self
     end
 
@@ -43,7 +46,6 @@ module Gotenberg
       response || raise(exception)
     end
 
-
     private
 
     def modify_metadata?

data/lib/gotenberg/files.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+require 'faraday/multipart'
+
+module Gotenberg
+  module Files
+
+    private
+
+    def files
+      @files ||= []
+    end
+
+    def load_file_from_source source
+      io, filename = 
+        case source
+        when String
+          [IO.binread(source), File.basename(source)]
+        when Array
+          source
+        end
+
+      [io, filename]
+    end
+
+    def multipart_file body, filename, content_type = 'application/octet-stream'
+      Faraday::Multipart::FilePart.new(StringIO.new(body), content_type, filename)
+    end
+  end
+end

data/lib/gotenberg/libreoffice/{files.rb → tools.rb}

@@ -1,10 +1,8 @@
-require 'faraday'
-require 'faraday/multipart'
 require 'gotenberg/utilities/index'
 
 module Gotenberg
   class Libreoffice
-    module Files
+    module Tools
 
      # 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.
@@ -12,7 +10,9 @@ module Gotenberg
      # 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))
+          io, filename = load_file_from_source(source)
+
+          files << multipart_file(io, merge_prefix(index) + filename)
         end
 
         @endpoint = '/forms/libreoffice/convert'
@@ -22,10 +22,6 @@ module Gotenberg
 
       private
 
-      def files
-        @files ||= []
-      end
-
       def zip_mode?
         properties['merge'] != true && files.size > 1
       end
@@ -33,10 +29,6 @@ module Gotenberg
       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.rb

@@ -1,14 +1,15 @@
 require 'gotenberg/libreoffice/properties'
-require 'gotenberg/libreoffice/files'
+require 'gotenberg/libreoffice/tools'
 require 'gotenberg/headers'
 require 'gotenberg/metadata'
+require 'gotenberg/files'
 require 'gotenberg/client'
 require 'gotenberg/exiftools'
 require 'gotenberg/exceptions'
 
 module Gotenberg
   class Libreoffice
-    include Properties, Files, Headers, Metadata
+    include Properties, Files, Headers, Metadata, Tools
 
     attr_accessor :base_path
     attr_reader :endpoint, :response, :exception

data/lib/gotenberg/pdf_engines/{files.rb → tools.rb}

@@ -1,17 +1,17 @@
-require 'faraday'
-require 'faraday/multipart'
 require 'gotenberg/utilities/index'
 
 module Gotenberg
   class PdfEngines
-    module Files
+    module Tools
 
       # 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))
+          io, filename = load_file_from_source(source)
+          
+          files << multipart_file(io, merge_prefix(index) + filename)
         end
 
         @endpoint = '/forms/pdfengines/merge'
@@ -23,13 +23,13 @@ module Gotenberg
       # 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))
+      def convert *sources, format: 'PDF/A-1a'
+        sources.each do |source|
+          files << multipart_file(*load_file_from_source(source))
         end
 
+        properties['pdfFormat'] = format
+
         @endpoint = '/forms/pdfengines/convert'
         @pdf_engines_convert = true
 
@@ -38,10 +38,6 @@ module Gotenberg
 
       private
 
-      def files
-        @files ||= []
-      end
-
       def zip_mode?
         @pdf_engines_convert && files.size > 1
       end
@@ -49,10 +45,6 @@ module Gotenberg
       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.rb

@@ -1,14 +1,15 @@
 require 'gotenberg/pdf_engines/properties'
-require 'gotenberg/pdf_engines/files'
+require 'gotenberg/pdf_engines/tools'
 require 'gotenberg/headers'
 require 'gotenberg/metadata'
+require 'gotenberg/files'
 require 'gotenberg/client'
 require 'gotenberg/exiftools'
 require 'gotenberg/exceptions'
 
 module Gotenberg
   class PdfEngines
-    include Properties, Files, Headers, Metadata
+    include Properties, Files, Headers, Metadata, Tools
 
     attr_accessor :base_path
     attr_reader :endpoint, :response, :exception

data/lib/gotenberg/version.rb

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

data/lib/gotenberg-ruby.rb

@@ -5,6 +5,7 @@ module Gotenberg
   autoload :Chromium, 'gotenberg/chromium'
   autoload :Libreoffice, 'gotenberg/libreoffice'
   autoload :PdfEngines, 'gotenberg/pdf_engines'
+  autoload :Exiftools, 'gotenberg/exiftools'
   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.6
+  version: 1.0.8
 platform: ruby
 authors:
 - sanzstez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -90,23 +90,24 @@ files:
 - lib/gotenberg/analyzers/resource.rb
 - lib/gotenberg/backtrace.rb
 - lib/gotenberg/chromium.rb
-- lib/gotenberg/chromium/files.rb
 - lib/gotenberg/chromium/properties.rb
+- lib/gotenberg/chromium/tools.rb
 - lib/gotenberg/client.rb
 - lib/gotenberg/compiler.rb
 - lib/gotenberg/configuration.rb
 - lib/gotenberg/exceptions.rb
 - lib/gotenberg/exiftools.rb
 - lib/gotenberg/extractors.rb
+- lib/gotenberg/files.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/libreoffice/tools.rb
 - lib/gotenberg/metadata.rb
 - lib/gotenberg/pdf_engines.rb
-- lib/gotenberg/pdf_engines/files.rb
 - lib/gotenberg/pdf_engines/properties.rb
+- lib/gotenberg/pdf_engines/tools.rb
 - lib/gotenberg/railtie.rb
 - lib/gotenberg/utilities/index.rb
 - lib/gotenberg/utilities/inline_resource.rb