cloudrunpdf 0.1.6 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaec64c1929adc238dbeb808c17fb4497db4cd6c64187e5a5b21963d9d0cb7b9
-  data.tar.gz: 9fc6bed30f71eb8b676024e41ffd84dc82211d6f03a02db56ad490fe21d76e7f
+  metadata.gz: ceb097585f4b4e884deb1ae3b6d349009c17060dfb13da34a28138ac95c6e0a0
+  data.tar.gz: f21bd07a253112039657802b0a6093aa3fa1c45cca4cccd27804c5339a80d408
 SHA512:
-  metadata.gz: 9e773c8d2f092bccfd31be64a6f5ed17fe8e15bfce36ba672e38125381cc782e92e53d9770a7a7ced9419b815ca8074408a711cb39ef405fe5a5718f312acee2
-  data.tar.gz: 0e811369f102218e55ea4bb867ba4218a051ee055fe41e7cdcfbfa7089c45fe75aa76f2a71a2d3db83ef43802da54610c43b737fb0220da1f6953999a506e339
+  metadata.gz: 9df0539cc82e2c0125a97501d86000540c0ce9863877cc61a0e9181d819eff459b79b3b4139b8c5a7efda61196a0cdb8677eef1df92945a08a397e97c4f55d90
+  data.tar.gz: be691daae2c5236b8ed292e59f511cfe9638a8bfdd57dd02e7a89261da22028070a9e623556a29a4731d9f30ce42760f57b763eafce914a65caccf3c3f620cd3

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,64 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - '*.gemspec'
+    - Gemfile
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+Layout/ArrayAlignment:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 4
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 4
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/FirstArgumentIndentation:
+  Enabled: false
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 100
+
+Style/WordArray:
+  EnforcedStyle: brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+Style/ZeroLengthPredicate:
+  Enabled: false
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_inside_condition
+Style/Documentation:
+  Enabled: false
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false

data/Gemfile.lock

@@ -1,31 +1,85 @@
 PATH
   remote: .
   specs:
-    cloudrunpdf (0.1.5)
+    cloudrunpdf (0.2.1)
+      base64
       combine_pdf
       faraday
+      logger
+      ostruct
 
 GEM
   remote: https://rubygems.org/
   specs:
-    combine_pdf (1.0.23)
+    ast (2.4.2)
+    base64 (0.3.0)
+    combine_pdf (1.0.26)
       matrix
       ruby-rc4 (>= 0.1.5)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    diff-lcs (1.5.0)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    logger (1.7.0)
     matrix (0.4.2)
+    net-http (0.4.1)
+      uri
+    ostruct (0.6.0)
+    parallel (1.24.0)
+    parser (3.3.0.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.60.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     ruby-rc4 (0.1.5)
-    ruby2_keywords (0.0.5)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
+    vcr (6.2.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
+  arm64-darwin-24
 
 DEPENDENCIES
   cloudrunpdf!
   rake (~> 13.0)
+  rspec
+  rubocop
+  vcr
 
 BUNDLED WITH
-   2.2.32
+   2.5.4

data/README.md

@@ -1,8 +1,6 @@
 # Cloudrunpdf
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cloudrunpdf`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The cloudrunpdf Ruby gem allows delegating the rendering of HTML to PDF to a dedicated Google Cloud Run container. This container should be based on the [cloudpdf](https://bitbucket.org/remark_innovation_center/cloudpdf/src/main/) container image.
 
 ## Installation
 
@@ -22,22 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See `bin/smoketest` for a concrete usage example.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. After making any changes, for quality assurance you can execute the rspec test suite by running `bin/rspec`. In addition, static analysis can be performed by running `bin/rubocop`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cloudrunpdf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cloudrunpdf/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Cloudrunpdf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cloudrunpdf/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-task default: %i[]
+require 'bundler/gem_tasks'
+task default: []

data/bin/console

@@ -1,15 +1,7 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
-require "bundler/setup"
-require "cloudrunpdf"
+require 'bundler/setup'
+require 'cloudrunpdf'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'rubygems'
+require 'bundler/setup'
+require 'cloudrunpdf'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/bin/smoketest

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cloudrunpdf'
+
+require 'base64'
+
+if ENV['GCLOUD_AUTH_TOKEN'].nil? || ENV['GCLOUD_AUTH_TOKEN'].empty?
+  puts <<~MSG
+
+    Please run the following before executing the smoketest:
+
+      gcloud auth login; gcloud auth application-default login; export GCLOUD_AUTH_TOKEN=$(gcloud auth print-identity-token)
+
+  MSG
+  exit(1)
+end
+
+builder = Cloudrunpdf::Builder.new
+result = builder.print({ document: Base64.encode64('<html><body>Hello, world!</body></html>') })
+
+FileUtils.mkdir_p('tmp')
+File.write('tmp/result.pdf', result)
+`open tmp/result.pdf`

data/bitbucket-pipelines.yml

@@ -0,0 +1,28 @@
+image: remarksolutions/ci-image:ruby-31
+
+pipelines:
+  default:
+    # - step:
+    #     name: Quality Assurance
+    #     script:
+    #       - bundle install --local
+    #       - bin/rspec
+    #       - bin/rubocop
+    #     caches:
+    #       - bundler
+    - step:
+        name: Build and Upload Gem
+        script:
+          - gem install geminabox
+          - gem build cloudrunpdf.gemspec
+          - gem inabox cloudrunpdf-*.gem --host $GEMINABOX_URL
+        caches:
+          - bundler
+        runs-on:
+          - self.hosted
+definitions:
+  caches:
+    bundler: vendor/bundle
+  services:
+    docker:
+      memory: 3072

data/lib/cloudrunpdf/builder.rb

@@ -1,18 +1,20 @@
-# frozen_string_literal: true
-
+require 'faraday'
 require 'combine_pdf'
 
 module Cloudrunpdf
   class Builder
     def initialize
       @configuration = Cloudrunpdf.configuration
-      @token = retrieve_authentication_token
+      @provider = provider
     end
 
     def print(data)
       threads = []
+      data = [data] unless data.is_a?(Array)
+
+      Thread.report_on_exception = false
 
-      Array.wrap(data).each do |entry|
+      data.each do |entry|
         threads.append(
           Thread.new { Thread.current[:pdf] = generate_pdf(entry) }
         )
@@ -26,33 +28,16 @@ module Cloudrunpdf
     end
 
     def generate_pdf(data)
-      conn = Faraday.new
-      headers = { 'Content-Type' => 'application/json' }
-      headers['Authorization'] = 'Bearer ' + @token if @configuration.google?
+      connection = @provider.connection
 
-      conn.post(@configuration.cloud_function_url) do |req|
+      connection.post(@configuration.cloud_function_url) do |req|
         req.body = data.to_json
-        req.headers = headers
       end
     end
 
-    private
-
-    def retrieve_authentication_token
-      # We only auth to cloudrun
-      return unless @configuration.google?
-
-      if ENV['GCLOUD_AUTH_TOKEN'].present?
-        @token ||= ENV['GCLOUD_AUTH_TOKEN']
-      elsif Rails.env.in?(['development', 'test'])
-        @token ||= `gcloud auth print-identity-token`.strip
-      else
-        @token ||= Faraday.get(
-            "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=#{@configuration.cloud_function_url}&format=full",
-            {},
-            { metadata_flavor: 'Google' }
-          ).body
-      end
+    def provider
+      klass = "Cloudrunpdf::Providers::#{@configuration.platform}"
+      @provider ||= Object.const_get(klass).new(@configuration)
     end
   end
 end

data/lib/cloudrunpdf/configuration.rb

@@ -3,16 +3,18 @@
 module Cloudrunpdf
   # Configuration options for gem
   class Configuration
-    attr_accessor :cloud_function_url, :auth
+    attr_accessor :cloud_function_url, :auth, :token
 
     AUTHS = [
       :google,
-      :aliyun
+      :aliyun,
+      :amazon
     ].freeze
 
     def initialize
-      @cloud_function_url = 'https://cloudpdf-7zhay37huq-od.a.run.app'.freeze
+      @cloud_function_url = 'https://cloudpdf-7zhay37huq-od.a.run.app'
       @auth = :google
+      @token = nil
     end
 
     AUTHS.each do |auth|
@@ -20,5 +22,15 @@ module Cloudrunpdf
         @auth == auth
       end
     end
+
+    def platform
+      @auth.to_s.capitalize
+    end
+
+    def auth=(auth)
+      raise Cloudrunpdf::InvalidProviderError unless AUTHS.include?(auth.to_sym)
+
+      @auth = auth.to_sym
+    end
   end
 end

data/lib/cloudrunpdf/exceptions.rb

@@ -0,0 +1,4 @@
+module Cloudrunpdf
+  class InvalidProviderError < StandardError
+  end
+end

data/lib/cloudrunpdf/providers/aliyun.rb

@@ -0,0 +1,26 @@
+module Cloudrunpdf
+  module Providers
+    class Aliyun
+      def initialize(configuration = nil)
+        @configuration = configuration
+        @token = token
+      end
+
+      def token
+        nil
+      end
+
+      def connection
+        return unless @configuration
+
+        Faraday::Connection.new(
+          headers: {
+            'Content-Type' => 'application/json'
+          }.compact
+        ) do |conn|
+          conn.response :raise_error
+        end
+      end
+    end
+  end
+end

data/lib/cloudrunpdf/providers/amazon.rb

@@ -0,0 +1,36 @@
+module Cloudrunpdf
+  module Providers
+    class Amazon
+      def initialize(configuration = nil)
+        @configuration = configuration
+        @token = token
+      end
+
+      def token
+        return unless @configuration
+
+        if @configuration.token
+          return @token ||= @configuration.token
+        end
+
+        # To be deprecated
+        if !ENV['CLOUD_API_TOKEN'].nil?
+          @token ||= ENV.fetch('CLOUD_API_TOKEN', nil)
+        end
+      end
+
+      def connection
+        return unless @configuration
+
+        Faraday::Connection.new(
+          headers: {
+            'Content-Type' => 'application/json',
+            'Authorization' => "Bearer #{@token}"
+          }.compact
+        ) do |conn|
+          conn.response :raise_error
+        end
+      end
+    end
+  end
+end

data/lib/cloudrunpdf/providers/google.rb

@@ -0,0 +1,44 @@
+module Cloudrunpdf
+  module Providers
+    class Google
+      def initialize(configuration = nil)
+        @configuration = configuration
+        @token = token
+      end
+
+      def token
+        return unless @configuration
+
+        if @configuration.token
+          return @token ||= @configuration.token
+        end
+
+        # To be deprecated
+        if !ENV['GCLOUD_AUTH_TOKEN'].nil?
+          @token ||= ENV.fetch('GCLOUD_AUTH_TOKEN', nil)
+        elsif Object.const_defined?(:Rails) && Rails.env.in?(['development', 'test'])
+          @token ||= `gcloud auth print-identity-token`.strip
+        else
+          @token ||= Faraday.get(
+              "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=#{@configuration.cloud_function_url}&format=full",
+              {},
+              { metadata_flavor: 'Google' }
+            ).body
+        end
+      end
+
+      def connection
+        return unless @configuration
+
+        Faraday::Connection.new(
+          headers: {
+            'Content-Type' => 'application/json',
+            'Authorization' => ("Bearer #{@token}" if @configuration.google?)
+          }.compact
+        ) do |conn|
+          conn.response :raise_error
+        end
+      end
+    end
+  end
+end

data/lib/cloudrunpdf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudrunpdf
-  VERSION = '0.1.6'
+  VERSION = '0.2.1'
 end

data/lib/cloudrunpdf.rb

@@ -1,10 +1,13 @@
-# frozen_string_literal: true
 require_relative 'cloudrunpdf/configuration'
 require_relative 'cloudrunpdf/version'
 require_relative 'cloudrunpdf/builder'
+require_relative 'cloudrunpdf/exceptions'
+
+['google', 'aliyun', 'amazon'].each do |platform|
+  require_relative "cloudrunpdf/providers/#{platform}"
+end
 
 module Cloudrunpdf
-  # add configuration to Gem
   class << self
     def configuration
       @configuration ||= Configuration.new

metadata

@@ -1,16 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: cloudrunpdf
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors:
 - Bas Schoenmakers
 - Jasper vd Berg
+- Jesse Tilro
+- Badrul Idris
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2025-11-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: combine_pdf
   requirement: !ruby/object:Gem::Requirement
@@ -39,14 +83,60 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  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: logger
+  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: base64
+  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'
 description:
 email:
 - bas.schoenmakers@remarkgroup.com
 - jasper.vandenberg@remarkgroup.com
+- jesse.tilro@remarkgroup.com
+- badrul.idris@scordigitalsolutions.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -54,10 +144,19 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
 - bin/setup
+- bin/smoketest
+- bitbucket-pipelines.yml
 - lib/cloudrunpdf.rb
 - lib/cloudrunpdf/builder.rb
 - lib/cloudrunpdf/configuration.rb
+- lib/cloudrunpdf/exceptions.rb
+- lib/cloudrunpdf/providers/aliyun.rb
+- lib/cloudrunpdf/providers/amazon.rb
+- lib/cloudrunpdf/providers/google.rb
 - lib/cloudrunpdf/version.rb
 homepage: https://remarkgroup.com
 licenses:
@@ -80,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Generate PDF with Google Cloud Function.