gotenberg 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d984cff5f3354d5dd5ab3a8eb7210fa49532125cf9d8d7ef57a729243d3434aa
-  data.tar.gz: c1f52733269daac044db7c1930d0b276924484aaa365a2919719fa2e55e70c98
+  metadata.gz: 8f53f3f0cd1c87eae43c03fb07bc9bd9096deaa27fe9d6c2cb85f2dbf04f2e24
+  data.tar.gz: c79d077d87f6f60513fe293c92442527847fab4fc9c269780375c21b18b098de
 SHA512:
-  metadata.gz: 3a86064442da347abc5a5bc1aebdced0921935f545bc300d49ef69ad63c33f86a4f24a129dfc158aec5ffda08a9de331f4bb77fc218017b88e7602e8662bd080
-  data.tar.gz: ef1dd7bc42f1763bf4b1a1d22c5cf5937cc924db422c56d353dc7c92be48683ea0d531b332ff9cfbf88391e641d0006dec06b2c7c91ddda1ea5d6689c7bfbe5b
+  metadata.gz: 5628e26404b94a39b1215be8ef597987493a01a61d9a1bddd28a912bd457bc499f99b25d0b67425bb7daf6b85d8ad37d0a478afcca231863b53631012424895d
+  data.tar.gz: '069da1f064e1b24b87d494efda58e2eb80387aae039db6a06067bb2f89db3dd7f6a0764623bb634623dcf5683b4cce7f0b931ae922371afebf3e6711432107ca'

data/lib/gotenberg/client.rb

@@ -48,6 +48,7 @@ module Gotenberg
     #   client = Gotenberg::Client.new("http://localhost:3000")
     #   pdf_content = client.html(htmls, asset_paths, properties)
     #
+    # Credit: https://github.com/jbd0101/ruby-gotenberg-client/blob/master/lib/gotenberg.rb
     def html(htmls, asset_paths, properties = {}) # rubocop:disable Metrics/CyclomaticComplexity
       raise GotenbergDownError unless up?
 

data/lib/gotenberg/helper.rb

@@ -4,7 +4,8 @@ module Gotenberg
   module Helper # rubocop:disable Style/Documentation
     class ExtensionMissing < StandardError; end
 
-    class PropshaftAsset # rubocop:disable Style/Documentation
+    # Credits: https://github.com/mileszs/wicked_pdf/blob/master/lib/wicked_pdf/wicked_pdf_helper/assets.rb
+    class PropshaftAsset
       attr_reader :asset
 
       def initialize(asset)
@@ -63,6 +64,11 @@ module Gotenberg
       end
     end
 
+    # Returns the base64 encoded content of a static asset.
+    #
+    # @param asset_name [String] the name of the asset
+    # @raise [MissingAsset] if the asset is not found
+    # @return [String] the base64 encoded content of the asset
     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?
@@ -71,6 +77,11 @@ module Gotenberg
       "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
     end
 
+    # Returns the static path of an asset based on its extension.
+    #
+    # @param asset_name [String] the name of the asset
+    # @raise [ExtensionMissing] if the asset extension is missing
+    # @return [String] the static path of the asset
     def goten_static_asset_path(asset_name)
       ext = File.extname(asset_name).delete(".")
 
@@ -86,6 +97,10 @@ module Gotenberg
       determine_static_path(asset_type, asset_name)
     end
 
+    # Returns the compiled path of an asset.
+    #
+    # @param asset_name [String] the name of the asset
+    # @return [String] the compiled path of the asset
     def goten_compiled_asset_path(asset_name)
       Rails.public_path.to_s +
         ActionController::Base.helpers.asset_path(asset_name)
@@ -93,6 +108,12 @@ module Gotenberg
 
     private
 
+    # Determines and returns the static path of an asset.
+    #
+    # @param asset_type [String] the type of the asset (e.g., "javascripts", "stylesheets", "images")
+    # @param asset_name [String] the name of the asset
+    # @raise [MissingAsset] if the asset is not found
+    # @return [String] the static path of the asset
     def determine_static_path(asset_type, asset_name)
       asset_root = Rails.root.join("app", "assets")
       path = asset_root.join(asset_type, asset_name)
@@ -107,7 +128,10 @@ module Gotenberg
       path.to_s
     end
 
-    # Thanks WickedPDF 🙏
+    # Finds and returns the asset for the given path.
+    #
+    # @param path [String] the path of the asset
+    # @return [PropshaftAsset, LocalAsset, Sprockets::Asset, nil] the found asset or nil if not found
     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)

data/lib/gotenberg/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gotenberg
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - bugloper
 - teknatha136
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -51,16 +51,16 @@ files:
 - lib/gotenberg/helper.rb
 - lib/gotenberg/railtie.rb
 - lib/gotenberg/version.rb
-homepage: https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg
+homepage: https://github.com/SELISEdigitalplatforms/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
+  homepage_uri: https://github.com/SELISEdigitalplatforms/gotenberg
+  source_code_uri: https://github.com/SELISEdigitalplatforms/gotenberg
+  changelog_uri: https://github.com/SELISEdigitalplatforms/gotenberg/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'false'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: A simple Ruby client for gotenberg
 test_files: []