gotenberg-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ee579fe775ebbac8cc6eef4e931138f9962b8d0401f1e1bc556bcdf81d1c039
+  data.tar.gz: 8687f9bd12445598334671791e9fbebb50da3f13d4bfabc5be798a9eb89fa3ae
+SHA512:
+  metadata.gz: 3333fe62ab25ccbe23c9584af9633fb361576e47d97b13f3b43af9378f76fc7431142bb67b53feaf402ff13a7017495445733a68a3bc3dfec5ea5b5d4a6a2b4d
+  data.tar.gz: ff099effef5eaafe2c1ce89b1a1ca6f935ef44befa19abde53827cd504e5fb6efac7eca43a0e0b906b3a831ee7ed3ade5402b49dcdde4c821f54ad2cfc925190

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2022 sanzstez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+TODO

data/lib/gotenberg/analyzers/base.rb

@@ -0,0 +1,52 @@
+require 'faraday'
+require 'base64'
+
+module Gotenberg
+  module Analyzers
+    class Base
+      URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
+
+      attr_accessor :resource
+
+      def initialize resource
+        @resource = resource
+      end
+
+      def assets
+        [binary, filename]
+      end
+
+      private
+
+      def binary
+        @binary ||= remote? ? remote_source : local_source
+      end
+
+      def remote_source
+        Faraday.get(src).body
+      rescue StandardError => e
+        raise '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]
+      end
+
+      def filename
+        @filename ||= File.basename(src)
+      end
+
+      def remote?
+        src.match?(URI_REGEXP)
+      end
+
+      def src
+        resource[:src]
+      end
+    end
+  end
+end

data/lib/gotenberg/analyzers/css.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+require 'base64'
+require 'gotenberg/analyzers/base'
+
+module Gotenberg
+  module Analyzers
+    class Css < Base
+      def tag
+        if resource[:inline]
+          '<style type="text/css">%s</style>' % binary
+        else
+          '<link rel="stylesheet" href="%s" />' % filename
+        end
+      end
+    end
+  end
+end

data/lib/gotenberg/analyzers/image.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+require 'base64'
+require 'uri'
+require 'gotenberg/analyzers/base'
+
+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
+
+      private
+
+      def src_value
+        if resource[:inline]
+          'data:%s;base64,%s' % [mimetype, Base64.strict_encode64(binary)]
+        else
+          filename
+        end
+      end
+
+      def mimetype
+        MIME_TYPES[extension] || 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/gotenberg/analyzers/js.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+require 'base64'
+require 'gotenberg/analyzers/base'
+
+module Gotenberg
+  module Analyzers
+    class Js < Base
+      def tag
+        if resource[:inline]
+          '<script type="text/javascript">%s</script>' % binary
+        else
+          '<script src="%s"></script>' % filename
+        end
+      end
+    end
+  end
+end

data/lib/gotenberg/chromium/files.rb

@@ -0,0 +1,90 @@
+require 'faraday'
+require 'faraday/multipart'
+require 'gotenberg/compiler'
+
+module Gotenberg
+  class Chromium
+    module Files
+      # Adds a header to each page.
+      # Note: it automatically sets the filename to "header.html", as required by Gotenberg.
+      def header header
+        compiler = Compiler.new(header)
+
+        #File.open('header.html', 'w') { |f| f.write(compiler.body) }
+
+        files << multipart_file(compiler.body, 'header.html', 'text/html')
+      end
+
+      # Adds a footer to each page.
+      # Note: it automatically sets the filename to "footer.html", as required by Gotenberg.
+      def footer footer
+        compiler = Compiler.new(footer)
+
+        #File.open('footer.html', 'w') { |f| f.write(compiler.body) }
+
+        files << multipart_file(compiler.body, 'footer.html', 'text/html')
+      end
+
+      # Converts an HTML document to PDF.
+      # Note: it automatically sets the index filename to "index.html", as required by Gotenberg.
+      # See https://gotenberg.dev/docs/modules/chromium#html.
+      def html index
+        compiler = Compiler.new(index)
+
+        meta(extract_metadata_from_body(compiler.body))
+
+        files << multipart_file(compiler.body, 'index.html', 'text/html')
+
+        binary_assets(compiler.assets)
+
+        #File.open('index.html', 'w') { |f| f.write(compiler.body) }
+
+        @endpoint = '/forms/chromium/convert/html'
+
+        self
+      end
+
+      # 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 = []
+        files << multipart_file(index, 'index.html', 'text/html')
+
+        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 assets
+        assets.each do |(io, filename)|
+          files << multipart_file(io, filename)
+        end
+
+        self
+      end
+
+      def assets assets
+        assets.each do |f|
+          files << multipart_file(IO.binread(f), File.basename(f))
+        end
+
+        self
+      end
+
+      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
+    end
+  end
+end

data/lib/gotenberg/chromium/headers.rb

@@ -0,0 +1,50 @@
+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

@@ -0,0 +1,24 @@
+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

data/lib/gotenberg/chromium/properties.rb

@@ -0,0 +1,142 @@
+require 'json'
+
+module Gotenberg
+  class Chromium
+    module Properties
+
+      # Overrides the default paper size, in inches. Examples of paper size (width x height):
+      # Letter - 8.5 x 11 (default)
+      # Legal - 8.5 x 14
+      # Tabloid - 11 x 17
+      # Ledger - 17 x 11
+      # A0 - 33.1 x 46.8
+      # A1 - 23.4 x 33.1
+      # A2 - 16.54 x 23.4
+      # A3 - 11.7 x 16.54
+      # A4 - 8.27 x 11.7
+      # A5 - 5.83 x 8.27
+      # A6 - 4.13 x 5.83
+      def paper_size width, height
+        properties['paperWidth'] = width
+        properties['paperHeight'] = height
+
+        self
+      end
+
+      # Overrides the default margins (i.e., 0.39), in inches.
+      def margins top: nil, bottom: nil, left: nil, right: nil
+        properties['marginTop'] = top if top
+        properties['marginBottom'] = bottom if bottom
+        properties['marginLeft'] = left if left
+        properties['marginRight'] = right if right
+
+        self
+      end
+
+      # Forces page size as defined by CSS.
+      def prefer_css_page_size
+        properties['preferCssPageSize'] = true
+
+        self
+      end
+
+      # Prints the background graphics.
+      def print_background
+        properties['printBackground'] = true
+
+        self
+      end
+
+      # Sets the paper orientation to landscape.
+      def landscape
+        properties['landscape'] = true
+
+        self
+      end
+
+      # Overrides the default scale of the page rendering (i.e., 1.0).
+      def scale scale
+        properties['scale'] = scale
+
+        self
+      end
+
+      # Set the page ranges to print, e.g., "1-5, 8, 11-13". Empty means all pages.
+      def native_page_ranges ranges
+        properties['nativePageRanges'] = ranges
+
+        self
+      end
+
+      # Sets the duration (i.e., "1s", "2ms", etc.) to wait when loading an HTML document before converting it to PDF.
+      def wait_delay delay
+        properties['waitDelay'] = delay
+
+        self
+      end
+
+      # Sets the JavaScript expression to wait before converting an HTML document to PDF until it returns true.
+      # For instance: "window.status === 'ready'".
+      def wait_for_expression expression
+        properties['waitForExpression'] = expression
+
+        self
+      end
+ 
+      # Overrides the default "User-Agent" header.
+      def user_agent user_agent
+        properties['userAgent'] = user_agent
+
+        self
+      end
+
+      # Sets extra HTTP headers that Chromium will send when loading the HTML document.
+      def extra_http_headers headers
+        properties['userAgent'] = headers.to_json
+
+        self
+      end
+
+      # Forces Gotenberg to return a 409 Conflict response if there are exceptions in the Chromium console
+      def fail_on_console_exceptions
+        properties['failOnConsoleExceptions'] = true
+
+        self
+      end
+ 
+      # Forces Chromium to emulate the media type "print" or "screen".
+      def emulate_media_type type
+        properties['emulatedMediaType'] = type
+
+        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
+
+      # Converts a target URL to PDF.
+      # See https://gotenberg.dev/docs/modules/chromium#url.
+      def url url, extra_link_tags = [], extra_script_tags = []
+        links = extra_link_tags.flat_map { |url| { 'href' => url } }
+        scripts = extra_script_tags.flat_map { |url| { 'src' => url } }
+
+        properties['url'] = url
+        properties['extraLinkTags'] = links.to_json
+        properties['extraScriptTags'] = scripts.to_json
+
+        endpoint = '/forms/chromium/convert/url' 
+
+        self
+      end
+ 
+      def properties
+        @properties ||= {}
+      end
+    end
+  end
+end

data/lib/gotenberg/chromium.rb

@@ -0,0 +1,64 @@
+require 'gotenberg/chromium/properties'
+require 'gotenberg/chromium/files'
+require 'gotenberg/chromium/headers'
+require 'gotenberg/chromium/metadata'
+require 'gotenberg/client'
+require 'gotenberg/exiftools'
+require 'gotenberg/extractors'
+
+module Gotenberg
+  class Chromium
+    include Properties, Files, Headers, Metadata, Extractors
+
+    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
+
+      if success? && metadata_available? 
+        modify_metadata
+      end
+
+      self
+    end
+
+    def success?
+      @exception == nil
+    end
+
+    def to_binary
+      response
+    end
+
+    private
+
+    def transform
+      @response = client.adapter.post(endpoint, properties.merge(files: files), headers).body
+    rescue StandardError => e
+      @exception = e
+    end
+
+    def modify_metadata
+      @response = Exiftools.modify(response, metadata)
+    rescue StandardError => e
+      @exception = e
+    end
+
+    def client
+      @client ||= Client.new(base_path)
+    end
+  end
+end

data/lib/gotenberg/client.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'faraday/multipart'
+
+module Gotenberg
+  class Client
+    attr_reader :base_path
+
+    def initialize base_path
+      @base_path = base_path
+    end
+
+    def adapter
+      @adapter ||= Faraday.new(base_path) do |c|
+        c.request :multipart
+        c.request :url_encoded
+        c.adapter :net_http
+        c.response :raise_error
+      end
+    end
+  end
+end

data/lib/gotenberg/compiler.rb

@@ -0,0 +1,56 @@
+require 'json'
+require 'gotenberg/analyzers/image'
+require 'gotenberg/analyzers/js'
+require 'gotenberg/analyzers/css'
+
+module Gotenberg
+  class Compiler
+    CONTEXT_TAG_REGEX = /(<!-- GOTENBERG-CONTEXT-TAG (.+) -->)/.freeze
+
+    attr_accessor :html
+
+    def initialize html
+      @html = html
+    end
+
+    def body
+      @body ||= compile_body(html)
+    end
+
+    def assets
+      @assets ||= []
+    end
+
+    private
+
+    def compile_body body
+      body.gsub(CONTEXT_TAG_REGEX) do |context_tag|
+        resource = JSON.parse($2, symbolize_names: true)
+
+        analyzer = 
+          case resource[:tag]
+          when 'image'
+            Analyzers::Image.new(resource)
+          when 'js'
+            Analyzers::Js.new(resource)
+          when 'css'
+            Analyzers::Css.new(resource)
+          end
+
+        assets << 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
+end

data/lib/gotenberg/exiftools.rb

@@ -0,0 +1,61 @@
+require 'mini_exiftool'
+require 'tempfile'
+
+module Gotenberg
+  class Exiftools
+    attr_reader :io, :metadata
+
+    def self.modify io, metadata
+      new(io, metadata).call
+    end
+
+    def initialize io, metadata
+      @io = io
+      @metadata = metadata
+    end
+
+    def call
+      set_attributes
+      write
+
+      @body
+    end
+
+    def exiftools
+      @exiftools ||= MiniExiftool.new(tempfile.path)
+    end
+
+    private
+
+    def set_attributes
+      metadata.each do |property, v|
+        exiftools.public_send(('%s=' % property), v)
+      end
+    end
+
+    def write
+      exiftools.save!
+
+      @body = tempfile.read
+    rescue StandardError => e
+      raise e
+    ensure
+      tempfile.close
+      tempfile.unlink
+    end
+
+    def tempfile
+      @tempfile ||= tempfile_builder do |file|
+        file << io
+      end
+    end
+
+    def tempfile_builder
+      Tempfile.new(['gootenberg', '.pdf']).tap do |tempfile|
+        tempfile.binmode
+        yield tempfile if block_given?
+        tempfile.rewind
+      end
+    end
+  end
+end

data/lib/gotenberg/extractors.rb

@@ -0,0 +1,14 @@
+module Gotenberg
+  module Extractors
+
+    private 
+    
+    def extract_metadata_from_body body, variables = {}
+      body.match('<title.*?>(.*?)<\/title>') do
+        variables.merge!(title: $1)
+      end
+
+      variables
+    end
+  end
+end

data/lib/gotenberg/version.rb

@@ -0,0 +1,3 @@
+module Gotenberg
+  VERSION = '1.0.0'
+end

data/lib/gotenberg-ruby.rb

@@ -0,0 +1,5 @@
+require 'gotenberg/version'
+
+module Gotenberg
+  autoload :Chromium, 'gotenberg/chromium'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: gotenberg-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sanzstez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: mini_exiftool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A gem that provides a client interface for the Gotenberg PDF generate
+  service
+email:
+- sanzstez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/gotenberg-ruby.rb
+- lib/gotenberg/analyzers/base.rb
+- lib/gotenberg/analyzers/css.rb
+- lib/gotenberg/analyzers/image.rb
+- lib/gotenberg/analyzers/js.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
+- lib/gotenberg/exiftools.rb
+- lib/gotenberg/extractors.rb
+- lib/gotenberg/version.rb
+homepage: https://github.com/sanzstez/gotenberg-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: A gem that provides a client interface for the Gotenberg PDF generate service
+test_files: []