html2pdf-rails 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd4efa601a6172a9280fd4348c33c24a2bc2f9af4e3ddcbfcc5e563d949dd6ac
-  data.tar.gz: 728b7376604073203dc6a545bcdb99a2133bb52e77cc4c419b18e567a4925642
+  metadata.gz: 0f1f3b07b6c9e9ff8ca9080b8148465ac6fa3fefb1e5e7b2722f0b2b23c09264
+  data.tar.gz: ddf875845930cb93cac1acf2026db6d32e7e9a2aaf812775e212b10fa28cd1c0
 SHA512:
-  metadata.gz: a263cc651ad79ea756351e0aef44d6f2ece5c1e1d0577a5470fbba7217a2b45f2528fb2ecc5b962fae71952bc81067cf9e8905b55d1bdbac2b5f3ecc0c0f957d
-  data.tar.gz: d5becc033f6225ab5953f87b60cbae17a2c92259675ccd74930537536776e74f713e76145d8bdb27e96a839b1eafd412198952cf3d4600d7ec8b9c79673daeb5
+  metadata.gz: e1cb31fe1b8cf4d32fd7a34e3f93cc31775238c43728eee7b4c3d2339b3741ee0d2b354c1f1c6b3a32e95361724642d55966d64c8d5ebde6b359812cc300eda3
+  data.tar.gz: e2f92706c6383b135d55e03b3b9aec5b94b4c7e04f1980eaa643c6857db56c908dfcc82064ab9cacb3e23527813d4d26f2b38765d2b5bddc774dafa622a73988

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/README.md

@@ -51,6 +51,14 @@ Layout
     #content= yield
 ```
 
+### Put PDF to Cloud Storage and return signed url
+You can get signed url of Cloud Storage if your Cloud Funciton code support it.
+
+```ruby
+  pdf_url = render_pdf_and_get_url pdf: 'file_name'
+  redirect_to pdf_url
+```
+
 ### Advanced Usage with all available options
 
 ```ruby
@@ -91,7 +99,7 @@ const runOptions = {
 exports.html2pdf = functions
   .runWith(runOptions)
   .https.onRequest(
-    async ({ method, body: { html = "", pdfOptions = {} } }, res) => {
+    async ({ method, body: { html = "", putToStorage = false, pdfOptions = {} } }, res) => {
       const browser = await puppeteer.launch({
         headless: true,
         args: ["--no-sandbox"]
@@ -102,8 +110,12 @@ exports.html2pdf = functions
         waitUntil: "networkidle0"
       });
       const pdf = await page.pdf(pdfOptions);
-      res.header({ "Content-Type": "application/pdf" });
-      res.send(pdf);
+      if (putToStorage) {
+        // Code for Cloud Storage is omitted.
+      } else {
+        res.header({ "Content-Type": "application/pdf" });
+        res.send(pdf);
+      }
     }
   );
 ```

data/html2pdf-rails.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 5.2.0"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "retryable"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/html2pdf/rails/client.rb

@@ -1,21 +1,40 @@
 # frozen_string_literal: true
 
+require 'html2pdf/rails/errors'
+
 module Html2Pdf
   module Rails
     class Client
-      def self.post(*args)
-        self.new(Html2Pdf.config.endpoint).post(*args)
+      def self.post(**options)
+        self.new(Html2Pdf.config.endpoint).post(**options)
       end
 
       def initialize(endpoint)
         @uri = URI.parse(endpoint)
       end
 
-      def post(html, pdf_options = {})
+      def post(html:, put_to_storage: false, file_name: nil, disposition: nil, pdf_options: {})
         http = Net::HTTP.new(@uri.host, @uri.port).tap { |h| h.use_ssl = @uri.scheme == 'https' }
         request = Net::HTTP::Post.new(@uri.request_uri, headers)
-        request.body = { html: html, pdfOptions: pdf_options }.to_json
-        http.request(request)
+        request.body = {
+          html: html,
+          putToStorage: put_to_storage,
+          fileName: file_name,
+          responseDisposition: disposition,
+          pdfOptions: pdf_options
+        }.to_json
+        response = http.request(request)
+
+        case response.code
+        when '200'
+          response.body
+        when '503'
+          raise Html2Pdf::Rails::ServiceUnavailableError.new(response)
+        else
+          raise Html2Pdf::Rails::RequestError.new(response)
+        end
+      rescue Net::ReadTimeout
+        raise Html2Pdf::Rails::NetworkError
       end
 
       private

data/lib/html2pdf/rails/errors.rb

@@ -0,0 +1,19 @@
+module Html2Pdf
+  module Rails
+    class NetworkError < StandardError
+    end
+
+    class RequestError < StandardError
+      attr_reader :response
+
+      def initialize(response, msg = nil)
+        msg ||= "html2pdf request failed and got HTTP status #{response.code}"
+        super(msg)
+        @response = response
+      end
+    end
+
+    class ServiceUnavailableError < RequestError
+    end
+  end
+end

data/lib/html2pdf/rails/rendering.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'retryable'
 require 'html2pdf/rails/client'
 
 module Html2Pdf
@@ -9,27 +10,54 @@ module Html2Pdf
         _html2pdf_make_and_send_pdf(options.delete(:pdf), options)
       end
 
+      def render_pdf_and_get_url(options)
+        _html2_pdf_render_pdf_and_get_url(options.delete(:pdf), options)
+      end
+
       private
 
+      def _html2pdf_default_options(pdf_name, options)
+        new_options = options.dup
+        new_options[:layout] ||= false
+        new_options[:template] ||= File.join(controller_path, action_name)
+        new_options[:pdf_options] ||= {}
+        new_options[:file_name] = "#{pdf_name}.pdf"
+        new_options[:disposition] ||= 'inline'
+        new_options
+      end
+
+      def _html2_pdf_render_pdf_and_get_url(pdf_name, options = {})
+        options = _html2pdf_default_options(pdf_name, options)
+        options[:put_to_storage] = true
+        json = JSON.parse(_html2pdf_make_pdf(options))
+        json['url']
+      end
+
       def _html2pdf_make_and_send_pdf(pdf_name, options = {})
-        options[:layout] ||= false
-        options[:template] ||= File.join(controller_path, action_name)
-        options[:disposition] ||= 'inline'
-        options[:pdf_options] ||= {}
+        options = _html2pdf_default_options(pdf_name, options)
 
         if options[:show_as_html]
           render_opts = options.slice(:template, :layout, :formats, :handlers)
           render(render_opts.merge({ content_type: 'text/html' }))
         else
           pdf_content = _html2pdf_make_pdf(options)
-          send_data(pdf_content, filename: pdf_name + '.pdf', type: 'application/pdf', disposition: options[:disposition])
+          send_data(pdf_content, filename: options[:file_name], type: 'application/pdf', disposition: options[:disposition])
         end
       end
 
       def _html2pdf_make_pdf(options = {})
         render_opts = options.slice(:template, :layout, :formats, :handlers)
-        html = render_to_string(render_opts)
-        Client.post(html, options[:pdf_options]).body
+        html = render_to_string(**render_opts)
+
+        Retryable.retryable(tries: 3, on: Html2Pdf::Rails::ServiceUnavailableError) do
+          Client.post(
+            html: html,
+            put_to_storage: options[:put_to_storage],
+            file_name: options[:file_name],
+            disposition: options[:disposition],
+            pdf_options: options[:pdf_options]
+          )
+        end
       end
     end
   end

data/lib/html2pdf/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Html2Pdf
   module Rails
-    VERSION = '0.1.1'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html2pdf-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - aki77
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,48 +24,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: retryable
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: PDF generator (from HTML) gem for Ruby on Rails
 email:
 - aki77@users.noreply.github.com
@@ -79,7 +93,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -88,6 +101,7 @@ files:
 - html2pdf-rails.gemspec
 - lib/html2pdf/rails.rb
 - lib/html2pdf/rails/client.rb
+- lib/html2pdf/rails/errors.rb
 - lib/html2pdf/rails/helper.rb
 - lib/html2pdf/rails/railtie.rb
 - lib/html2pdf/rails/rendering.rb
@@ -111,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: PDF generator (from HTML) gem for Ruby on Rails

data/Gemfile.lock

@@ -1,142 +0,0 @@
-PATH
-  remote: .
-  specs:
-    html2pdf-rails (0.1.1)
-      rails (>= 5.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (5.2.3)
-      actionpack (= 5.2.3)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailer (5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.3)
-      activesupport (= 5.2.3)
-      globalid (>= 0.3.6)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activestorage (5.2.3)
-      actionpack (= 5.2.3)
-      activerecord (= 5.2.3)
-      marcel (~> 0.3.1)
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
-    method_source (0.9.2)
-    mimemagic (0.3.3)
-    mini_mime (1.0.1)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nio4r (2.3.1)
-    nokogiri (1.10.3)
-      mini_portile2 (~> 2.4.0)
-    rack (2.0.7)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (5.2.3)
-      actioncable (= 5.2.3)
-      actionmailer (= 5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
-      activemodel (= 5.2.3)
-      activerecord (= 5.2.3)
-      activestorage (= 5.2.3)
-      activesupport (= 5.2.3)
-      bundler (>= 1.3.0)
-      railties (= 5.2.3)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sprockets (3.7.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.1)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  html2pdf-rails!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.17.2