gotenberg 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d984cff5f3354d5dd5ab3a8eb7210fa49532125cf9d8d7ef57a729243d3434aa
+  data.tar.gz: c1f52733269daac044db7c1930d0b276924484aaa365a2919719fa2e55e70c98
+SHA512:
+  metadata.gz: 3a86064442da347abc5a5bc1aebdced0921935f545bc300d49ef69ad63c33f86a4f24a129dfc158aec5ffda08a9de331f4bb77fc218017b88e7602e8662bd080
+  data.tar.gz: ef1dd7bc42f1763bf4b1a1d22c5cf5937cc924db422c56d353dc7c92be48683ea0d531b332ff9cfbf88391e641d0006dec06b2c7c91ddda1ea5d6689c7bfbe5b

data/lib/gotenberg/client.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+require "mime/types"
+require "net/http/post/multipart"
+require "tempfile"
+require "securerandom"
+require "fileutils"
+
+module Gotenberg
+  class IndexFileMissing < StandardError; end
+
+  # Client class for interacting with the Gotenberg API
+  class Client
+    # Initialize a new Client
+    #
+    # @param api_url [String] The base URL of the Gotenberg API
+    def initialize(api_url)
+      @api_url = api_url
+    end
+
+    # Convert HTML files to PDF and write it to the output file
+    #
+    # @param htmls [Hash{Symbol => String}] A hash with the file name as the key and the HTML content as the value
+    # @param asset_paths [Array<String>] Paths to the asset files (like CSS, images) required by the HTML files
+    # @param properties [Hash] Additional properties for PDF conversion
+    # @option properties [Float] :paperWidth The width of the paper
+    # @option properties [Float] :paperHeight The height of the paper
+    # @option properties [Float] :marginTop The top margin
+    # @option properties [Float] :marginBottom The bottom margin
+    # @option properties [Float] :marginLeft The left margin
+    # @option properties [Float] :marginRight The right margin
+    # @option properties [Boolean] :preferCssPageSize Whether to prefer CSS page size
+    # @option properties [Boolean] :printBackground Whether to print the background
+    # @option properties [Boolean] :omitBackground Whether to omit the background
+    # @option properties [Boolean] :landscape Whether to use landscape orientation
+    # @option properties [Float] :scale The scale of the PDF
+    # @option properties [String] :nativePageRanges The page ranges to include
+    # @return [String] The resulting PDF content
+    # @raise [GotenbergDownError] if the Gotenberg API is down
+    #
+    # Example:
+    #   htmls = { index: "<h1>Html</h1>", header: "<h1>Header</h1>", footer: "<h1>Footer</h1>" }
+    #   asset_paths = ["path/to/style.css", "path/to/image.png"]
+    #   properties = { paperWidth: 8.27, paperHeight: 11.7, marginTop: 1, marginBottom: 1 }
+    #   client = Gotenberg::Client.new("http://localhost:3000")
+    #   pdf_content = client.html(htmls, asset_paths, properties)
+    #
+    def html(htmls, asset_paths, properties = {}) # rubocop:disable Metrics/CyclomaticComplexity
+      raise GotenbergDownError unless up?
+
+      raise IndexFileMissing unless (htmls.keys & ["index", :index]).any?
+
+      dir_name = SecureRandom.uuid
+      dir_path = File.join(Dir.tmpdir, dir_name)
+      FileUtils.mkdir_p(dir_path)
+
+      htmls.each do |key, value|
+        File.write(File.join(dir_path, "#{key}.html"), value)
+      end
+
+      uri = URI("#{@api_url}/forms/chromium/convert/html")
+
+      # Gotenberg requires all files to be in the same directory
+      asset_paths.each do |path|
+        FileUtils.cp(path, dir_path)
+      end
+
+      # Rejecting .. and .
+      entries = Dir.entries(dir_path).reject { |f| f.start_with?(".") }
+
+      payload = entries.each_with_object({}).with_index do |(entry, obj), index|
+        entry_abs_path = File.join(dir_path, entry)
+        mime_type = MIME::Types.type_for(entry_abs_path).first.content_type
+        obj["files[#{index}]"] = UploadIO.new(entry_abs_path, mime_type)
+      end
+
+      response = multipart_post(uri, payload.merge(properties))
+      response.body.dup.force_encoding("utf-8")
+    ensure
+      FileUtils.rm_rf(dir_path) if dir_path
+    end
+
+    # Check if the Gotenberg API is up and healthy
+    #
+    # @return [Boolean] true if the API is up, false otherwise
+    def up?
+      uri = URI("#{@api_url}/health")
+      request = Net::HTTP::Get.new(uri)
+      request.basic_auth(
+        ENV.fetch("GOTENBERG_API_BASIC_AUTH_USERNAME", nil),
+        ENV.fetch("GOTENBERG_API_BASIC_AUTH_PASSWORD", nil)
+      )
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      response = http.request(request)
+
+      response.is_a?(Net::HTTPSuccess) && JSON.parse(response.body)["status"] == "up"
+    rescue StandardError
+      false
+    end
+
+    private
+
+    def multipart_post(uri, payload)
+      request = Net::HTTP::Post::Multipart.new(uri.path, payload)
+      request.basic_auth(
+        ENV.fetch("GOTENBERG_API_BASIC_AUTH_USERNAME", nil),
+        ENV.fetch("GOTENBERG_API_BASIC_AUTH_PASSWORD", nil)
+      )
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.request(request)
+    end
+  end
+
+  # Custom error class for Gotenberg API downtime
+  class GotenbergDownError < StandardError; end
+end

data/lib/gotenberg/helper.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Gotenberg
+  module Helper # rubocop:disable Style/Documentation
+    class ExtensionMissing < StandardError; end
+
+    class PropshaftAsset # rubocop:disable Style/Documentation
+      attr_reader :asset
+
+      def initialize(asset)
+        @asset = asset
+      end
+
+      def content_type
+        asset.content_type.to_s
+      end
+
+      def to_s
+        asset.content
+      end
+
+      def filename
+        asset.path.to_s
+      end
+    end
+
+    class MissingAsset < StandardError # rubocop:disable Style/Documentation
+      attr_reader :path
+
+      def initialize(path, message)
+        @path = path
+        super(message)
+      end
+    end
+
+    class LocalAsset # rubocop:disable Style/Documentation
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def content_type
+        Mime::Type.lookup_by_extension(File.extname(path).delete("."))
+      end
+
+      def to_s
+        File.read(path)
+      end
+
+      def filename
+        path.to_s
+      end
+    end
+
+    class SprocketsEnvironment # rubocop:disable Style/Documentation
+      def self.instance
+        @instance ||= Sprockets::Railtie.build_environment(Rails.application)
+      end
+
+      def self.find_asset(*args)
+        instance.find_asset(*args)
+      end
+    end
+
+    def goten_asset_base64(asset_name)
+      asset = find_asset(goten_static_asset_path(asset_name))
+      raise MissingAsset.new(asset_name, "Could not find asset '#{asset_name}'") if asset.nil?
+
+      base64 = Base64.encode64(asset.to_s).delete("\n")
+      "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
+    end
+
+    def goten_static_asset_path(asset_name)
+      ext = File.extname(asset_name).delete(".")
+
+      raise ExtensionMissing if ext.empty?
+
+      asset_type =
+        case ext
+        when "js" then "javascripts"
+        when "css" then "stylesheets"
+        else "images"
+        end
+
+      determine_static_path(asset_type, asset_name)
+    end
+
+    def goten_compiled_asset_path(asset_name)
+      Rails.public_path.to_s +
+        ActionController::Base.helpers.asset_path(asset_name)
+    end
+
+    private
+
+    def determine_static_path(asset_type, asset_name)
+      asset_root = Rails.root.join("app", "assets")
+      path = asset_root.join(asset_type, asset_name)
+
+      unless File.exist?(path)
+        raise MissingAsset.new(
+          asset_name,
+          "Could not find static asset '#{asset_name}'"
+        )
+      end
+
+      path.to_s
+    end
+
+    # Thanks WickedPDF 🙏
+    def find_asset(path)
+      if Rails.application.assets.respond_to?(:find_asset)
+        Rails.application.assets.find_asset(path, base_path: Rails.application.root.to_s)
+      elsif defined?(Propshaft::Assembly) && Rails.application.assets.is_a?(Propshaft::Assembly)
+        PropshaftAsset.new(Rails.application.assets.load_path.find(path))
+      elsif Rails.application.respond_to?(:assets_manifest)
+        asset_path = File.join(Rails.application.assets_manifest.dir, Rails.application.assets_manifest.assets[path])
+        LocalAsset.new(asset_path) if File.file?(asset_path)
+      else
+        SprocketsEnvironment.find_asset(path, base_path: Rails.application.root.to_s)
+      end
+    end
+  end
+end

data/lib/gotenberg/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails"
+require "gotenberg/helper"
+
+module Gotenberg
+  class Railtie < Rails::Railtie # rubocop:disable Style/Documentation
+    initializer "gotenberg.register" do
+      ActiveSupport.on_load :action_view do
+        include Gotenberg::Helper
+      end
+    end
+  end
+end

data/lib/gotenberg/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gotenberg
+  VERSION = "1.0.0"
+end

data/lib/gotenberg.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "gotenberg/version"
+require_relative "gotenberg/client"
+require_relative "gotenberg/railtie" if defined?(Rails::Railtie)
+require_relative "gotenberg/helper"
+
+module Gotenberg
+  class GotenbergDownError < StandardError; end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: gotenberg
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- bugloper
+- teknatha136
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: A simple Ruby client for gotenberg
+email:
+- bugloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gotenberg.rb
+- lib/gotenberg/client.rb
+- lib/gotenberg/helper.rb
+- lib/gotenberg/railtie.rb
+- lib/gotenberg/version.rb
+homepage: https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg
+  source_code_uri: https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg
+  changelog_uri: https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A simple Ruby client for gotenberg
+test_files: []