html2pdf-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2206892dfeb806c182e8549bfa6cf84ae83b34493ef607e070ee17e059542b20
+  data.tar.gz: dad4f0a90421b5c82948343a08ad23664f4af7a02001cd93a2b7e826dbce42ee
+SHA512:
+  metadata.gz: 26700591edf5eb4826d2ed867383e173c5074c0e1a74f3b3ca91227f53be49eac99fbcc77e9ce9f2150788d59792d2c08fd8685724f8f0f94c1345bc8efeed8e
+  data.tar.gz: eaeddfd1ceacb84cb04175988fa01019be0877d766beceddafaff7ca60c9e2f327422f37e02f685c92f4d261958989a9f6b2cda1bc309ca61bad3f0adebe70a4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  sgcop: rails/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lala.akira@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in html2pdf-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    html2pdf-rails (0.1.0)
+      rails (>= 5.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      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.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      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.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      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.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      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.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  html2pdf-rails!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 aki
+
+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,127 @@
+# html2pdf-rails
+
+PDF generator (from HTML) gem for Ruby on Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html2pdf-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html2pdf-rails
+
+## Usage
+
+### Basic Usage
+
+Controller
+
+```ruby
+class ThingsController < ApplicationController
+  def show
+    respond_to do |format|
+      format.html
+      format.pdf do
+        render_to_pdf pdf: 'file_name'   # Excluding ".pdf" extension.
+      end
+    end
+  end
+end
+```
+
+Layout
+
+```haml
+!!!
+%html
+  %head
+    %meta{ charset: 'utf-8' }
+    = html2pdf_base_tag
+    = stylesheet_link_tag 'pdf', media: 'all'
+  %body
+    #header= image_tag 'logo.jpg'
+    #content= yield
+```
+
+### Advanced Usage with all available options
+
+```ruby
+class ThingsController < ApplicationController
+  def show
+    respond_to do |format|
+      format.html
+      format.pdf do
+        render_to_pdf(
+          pdf: 'file_name',                   # Excluding ".pdf" extension.
+          disposition: 'attachment',          # default 'inline'
+          template: 'things/show',
+          layout: 'pdf',                      # for a pdf.pdf.erb file
+          show_as_html: params.key?('debug'), # allow debugging based on url param
+          pdf_options: {                      # SEE: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions
+            margin: {
+              top: '30px'
+              bottom: '30px',
+            }
+          }
+        )
+      end
+    end
+  end
+end
+```
+
+### Cloud Functions for Firebase Sample
+
+```javascript
+const functions = require("firebase-functions");
+const puppeteer = require("puppeteer");
+
+const runOptions = {
+  timeoutSeconds: 20,
+  memory: "1GB"
+};
+exports.html2pdf = functions
+  .runWith(runOptions)
+  .https.onRequest(
+    async ({ method, body: { html = "", pdfOptions = {} } }, res) => {
+      const browser = await puppeteer.launch({
+        headless: true,
+        args: ["--no-sandbox"]
+      });
+      const page = await browser.newPage();
+      await page.emulateMedia("print");
+      await page.goto("data:text/html;charset=UTF-8," + html, {
+        waitUntil: "networkidle0"
+      });
+      const pdf = await page.pdf(pdfOptions);
+      res.header({ "Content-Type": "application/pdf" });
+      res.send(pdf);
+    }
+  );
+```
+
+## Configuration
+
+In `config/initializers/html2pdf_rails.rb`, you can configure the following values.
+
+```ruby
+Html2Pdf.configure do |config|
+  config.endpoint = 'YOUR_HTTP_TRIGGER_ENDPOINT'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SonicGarden/html2pdf-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html2pdf/rails"
+
+# 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"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/html2pdf-rails.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "html2pdf/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "html2pdf-rails"
+  spec.version       = Html2Pdf::Rails::VERSION
+  spec.authors       = ["aki77"]
+  spec.email         = ["aki77@users.noreply.github.com"]
+
+  spec.summary       = %q{PDF generator (from HTML) gem for Ruby on Rails}
+  spec.description   = %q{PDF generator (from HTML) gem for Ruby on Rails}
+  spec.homepage      = "https://github.com/SonicGarden/html2pdf-rails"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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"
+end

data/lib/html2pdf/rails.rb

@@ -0,0 +1,20 @@
+require 'active_support/configurable'
+require 'html2pdf/rails/version'
+require 'html2pdf/rails/railtie'
+
+module Html2Pdf
+  class Config
+    include ActiveSupport::Configurable
+    config_accessor :endpoint
+  end
+
+  class << self
+    def configure(&block)
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/html2pdf/rails/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Html2Pdf
+  module Rails
+    class Client
+      def self.post(*args)
+        self.new(Html2Pdf.config.endpoint).post(*args)
+      end
+
+      def initialize(endpoint)
+        @uri = URI.parse(endpoint)
+      end
+
+      def post(html, 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)
+      end
+
+      private
+
+      def headers
+        { 'Content-Type' => 'application/json' }
+      end
+    end
+  end
+end

data/lib/html2pdf/rails/helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Html2Pdf
+  module Rails
+    module Helper
+      def html2pdf_base_tag
+        # NOTE: for Ngrok
+        host = request.headers['HTTP_X_ORIGINAL_HOST'] || request.host
+        base_url = "#{request.protocol}#{host}"
+        tag.base href: base_url
+      end
+    end
+  end
+end

data/lib/html2pdf/rails/railtie.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'html2pdf/rails/rendering'
+require 'html2pdf/rails/helper'
+
+module Html2Pdf
+  module Rails
+    class Railtie < ::Rails::Railtie
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.prepend Rendering
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.include Helper
+      end
+
+      config.after_initialize do
+        if Html2Pdf.config.endpoint.blank?
+          raise 'Html2Pdf.config.endpoint is required'
+        end
+      end
+    end
+  end
+end

data/lib/html2pdf/rails/rendering.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'html2pdf/rails/client'
+
+module Html2Pdf
+  module Rails
+    module Rendering
+      def render_to_pdf(options)
+        make_and_send_pdf(options.delete(:pdf), options)
+      end
+
+      private
+
+      def make_and_send_pdf(pdf_name, options = {})
+        options[:layout] ||= false
+        options[:template] ||= File.join(controller_path, action_name)
+        options[:disposition] ||= 'inline'
+        options[:pdf_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 = make_pdf(options)
+          send_data(pdf_content, filename: pdf_name + '.pdf', type: 'application/pdf', disposition: options[:disposition])
+        end
+      end
+
+      def make_pdf(options = {})
+        render_opts = options.slice(:template, :layout, :formats, :handlers)
+        html = render_to_string(render_opts)
+        Client.post(html, options[:pdf_options]).body
+      end
+    end
+  end
+end

data/lib/html2pdf/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Html2Pdf
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: html2pdf-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aki77
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: PDF generator (from HTML) gem for Ruby on Rails
+email:
+- aki77@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- html2pdf-rails.gemspec
+- lib/html2pdf/rails.rb
+- lib/html2pdf/rails/client.rb
+- lib/html2pdf/rails/helper.rb
+- lib/html2pdf/rails/railtie.rb
+- lib/html2pdf/rails/rendering.rb
+- lib/html2pdf/rails/version.rb
+homepage: https://github.com/SonicGarden/html2pdf-rails
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: PDF generator (from HTML) gem for Ruby on Rails
+test_files: []