my_pdfkit 0.1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b592c911bea1ec92e16f47301ec55d71be516122
+  data.tar.gz: 85474282cf3891d96ef6232b117df788c56a7c3a
+SHA512:
+  metadata.gz: 72387294a13288ded50e4a01dbc4420757c5de7c63bf8ad8048ad38fe995122d03bb425a88daf2b279ac0966b0eba949feafe7245021e358c5cf50109f8910a0
+  data.tar.gz: 8183f0fba1596cbae5ca749fe739cf6dca9fb5b92a5ed0347ef33d9578f5879decc4ac2394cd1eeead42048afcac81821c6d8e9e80db074c8d0996a560edcf52

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.github/workflows/release-drafter.yml

@@ -0,0 +1,19 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        # with:
+          # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+          # config-name: my-config.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: "0 0 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/stale@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue has been marked as stale and will be automatically closed.'
+        stale-pr-message: 'This pull request has been marked as stale and will be automatically closed.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

data/.github/workflows/test.yml

@@ -0,0 +1,71 @@
+name: Test workflow
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+        rails:
+          - '~> 4.1'
+          - '~> 5.2'
+          - '~> 6.0.0'
+          - '~> 6.1'
+          - '~> 7.0.0'
+        exclude:
+          - ruby: '2.5'
+            rails: '~> 7.0.0'
+          - ruby: '2.6'
+            rails: '~> 7.0.0'
+          - ruby: '2.7'
+            rails: '~> 4.1'
+          - ruby: '3.0'
+            rails: '~> 4.1'
+          - ruby: '3.0'
+            rails: '~> 5.2'
+          - ruby: '3.1'
+            rails: '~> 4.1'
+          - ruby: '3.1'
+            rails: '~> 5.2'
+          - ruby: '3.1'
+            rails: '~> 6.0.0'
+    runs-on: ${{ matrix.os }}
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      # rubygems-update's latest is no longer compatible with ruby 2.5, so conditionally run ruby-setup setting the
+      # rubygem version the most recent valid version for 2.5:
+      # https://rubygems.org/gems/rubygems-update/versions/3.3.26
+      if: ${{ matrix.ruby == '2.5' }}
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        rubygems: 3.3.26
+        bundler: latest
+        bundler-cache: true
+    - uses: ruby/setup-ruby@v1
+      # otherwise, we can use rubygems latest
+      if: ${{ matrix.ruby != '2.5' }}
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        rubygems: latest
+        bundler: latest
+        bundler-cache: true
+
+    - name: Setup wkhtmltopdf
+      run: |
+        sudo apt-get install -y xfonts-base xfonts-75dpi
+        wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6-1/wkhtmltox_0.12.6-1.bionic_amd64.deb
+        sudo dpkg -i wkhtmltox_0.12.6-1.bionic_amd64.deb
+
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.bundle
+spec/custom_wkhtmltopdf_path.rb
+spec/test_save.pdf
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+my_pdfkit

data/.ruby-version

@@ -0,0 +1 @@
+2.6.9

data/.travis.yml

@@ -0,0 +1,46 @@
+language: ruby
+
+rvm:
+- 2.5
+- 2.6
+- 2.7
+- 3.0
+- 3.1
+
+env:
+  matrix:
+    - RAILS_VERSION="~> 4.1"
+    - RAILS_VERSION="~> 5.2"
+    - RAILS_VERSION="~> 6.0.0"
+    - RAILS_VERSION="~> 6.1"
+    - RAILS_VERSION="~> 7.0.0"
+
+jobs:
+  exclude:
+  - rvm: 2.5
+    env: RAILS_VERSION="~> 7.0.0"
+  - rvm: 2.6
+    env: RAILS_VERSION="~> 7.0.0"
+  - rvm: 2.7
+    env: RAILS_VERSION="~> 4.1"
+  - rvm: 3.0
+    env: RAILS_VERSION="~> 4.1"
+  - rvm: 3.0
+    env: RAILS_VERSION="~> 5.2"
+  - rvm: 3.1
+    env: RAILS_VERSION="~> 4.1"
+  - rvm: 3.1
+    env: RAILS_VERSION="~> 5.2"
+  - rvm: 3.1
+    env: RAILS_VERSION="~> 6.0.0"
+
+cache: bundler
+
+before_install:
+  - gem update --system
+  - gem update bundler
+
+before_script:
+  - "sudo apt-get -qq -y install fontconfig libxrender1"
+  - "wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.xenial_amd64.deb"
+  - "sudo apt-get install ./wkhtmltox_0.12.5-1.xenial_amd64.deb"

data/CHANGELOG.md

@@ -0,0 +1,154 @@
+2023-02-27
+=================
+  * Bump to 0.8.7.3
+  * Allow passing a `Pathname` object to the `path` argument by @yujideveloper in https://github.com/pdfkit/pdfkit/pull/522
+  * Update repeatable options by @mguidetti in https://github.com/pdfkit/pdfkit/pull/524
+
+2022-10-18
+=================
+  * Bump to 0.8.7.2
+  * Call IO.popen with an Array of command arguments (#519)
+
+2022-10-17
+=================
+  * Bump to 0.8.7.1
+  * Support non-lower-case Content-Type header provided by app (#516)
+
+2022-10-02
+=================
+  * Bump to 0.8.7
+  * Lowercase the header names for rack 3 changes (#511)
+  * Partially escaped URLs should be escaped (#509)
+
+2022-04-11
+=================
+  * Bump to 0.8.6
+  * Update ruby and rails versions
+
+2021-01-23
+=================
+  * Bump to 0.8.5
+  * Make `MyPDFKit::VERSION` public (#484) 
+  * Fix to render stylesheets as html safe string on Rails 6 (#483)
+      * Adds support for Rails 6
+
+2020-08-16
+=================
+  * Bump to 0.8.4.3.2
+  * Reduce scope of middleware exception handling (#476)
+
+2020-07-05
+=================
+  * Bump to 0.8.4.3.1
+  * Don't override request level Content-Disposition header if it exists (#466)
+  * Update rake (#471)
+  * Add missing require statements for tempfile (#467)
+  * Only grab last line of bundle exec which output (#464)
+  * Return 500 status when an exception is caught in middleware (#469)
+  * Update Travis CI URL for wkhtmltopf (#473)
+  
+2020-04-01
+=================
+  * Bump to 0.8.4.2
+  * Improve path detection feedback (#460)
+  * Fix typos (#444)
+  * Update readme (#439)
+  
+2019-02-22
+=================
+  * Bump to 0.8.4.1
+  * Make PDFkit threadsafe (#377)
+  * Update activesupport (#434)
+
+2019-02-21
+=================
+  * Bump to 0.8.4
+  * Removed support for Ruby < 2.2
+  * Xvfb support (#277)
+  * Remove 'config.protocol' from the README (#389)
+
+2015-08-26
+=================
+  * Bump to 0.8.2
+  * Fix URI errors for users using MyPDFKit in contexts with 'uri' not
+    already required (thanks christhekeele)
+
+2015-08-20
+=================
+  * Bump to 0.8.1
+  * Fix shell escaping issues for Windows (thanks muness)
+  * Fix shell escaping issues for URLs, introduced in 0.5.3 release
+
+2015-07-08
+=================
+  * Bump to 0.8.0
+  * Support Cover and Table Of Contents options (thanks @nicpillinger)
+  * Fix repeatings keys with string values
+  * Fix caching bug (thanks @jocranford)
+  * Fix munging of relative paths (thanks @jocranford)
+  * Fix bug where nil values did not stay nil (thanks @tylerITP)
+
+2015-05-06
+=================
+  * Bump to 0.7.0
+  * Fix issue #230 where MyPDFKit called `bundle exec` without a Gemfile
+  * Fix issue #183 where MyPDFKit broke the path to wkhtmltopdf.exe by escaping
+    spaces in paths
+  * Improve performance by not storing the PDF in memory if a path is
+    provided. Thanks @mikefarah
+  * Middleware now infers HTTP or HTTPS from environment for relative URLs
+
+2014-04-20
+==================
+  * Bump to 0.6.2
+  * There was a bug where parsing meta tags would include the option name
+    causing an invalid command to be generated. This was fixed in #229 after
+    being reported by Frank Oxener.
+
+2014-02-18
+==================
+  * Bump to 0.6.0
+  * Added ability to run wkhtmltopdf without `--quiet`
+  * Now handles repeatable options as both config parameters and meta tag
+    options
+  * Fix status code 2 being treated as failure
+  * Escape `\X` in styesheets
+  * Allow controllers to set MyPDFKit-save-pdf
+  * Fix Middleware not respecting subdomains in path
+
+2013-06-12
+==================
+  * Bump to 0.5.4
+  * Fix broken page numbers (https://github.com/pdfkit/pdfkit/pull/181)
+
+2013-02-21
+==================
+  * Bump to 0.5.3
+  * Fix security vulnerability due to unsanitized strings being passed to `wkhtmltopdf` (https://github.com/pdfkit/pdfkit/issues/164)
+
+2011-07-02
+==================
+  * Bump to 0.5.2
+  * Fix of dealing with ActiveSupport::SafeBuffer >= 3.0.8.
+  * Fix for meta tag options getting dropped in REE 1.8.7.
+  * Fix on bundler environment detection.
+
+2011-06-17
+==================
+  * Bump to 0.5.1
+  * Fix for response body coming through as an array.
+  * Added root_url configuration for setup where a host my not know its own name.
+  * Awareness of Bundler when looking for the wkhtmltopdf executable.
+  * Fix for file data getting truncated in Ruby 1.8.6
+  * Fix for 0.5.0 release getting stuck rendering all requests as PDFs.
+  * More robust meta tag detection.
+
+2010-12-27
+==================
+  * Bump to 0.5.0
+  * Switched to popen - adds support for JRuby and Windows
+  * Pulled in support for pdf rendering conditions in middleware via Rémy Coutable
+  * Use `which` to try and determine path to wkhtmltopdf
+  * Removed wkhtmltopdf auto installer
+  * Changed :disable\_smart\_shrinking to false for default options.
+  * Added History.md

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'activesupport', ENV['RAILS_VERSION'] || '~> 4.1'
+  gem 'simplecov', require: false
+end
+
+group :development, :test do
+  gem 'pry'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jdpace
+
+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/POST_INSTALL

@@ -0,0 +1,14 @@
+******************************************************************
+
+Install wkhtmltopdf:
+
+1. Install by hand (recomended):
+
+        https://github.com/pdfkit/MyPDFKit/wiki/Installing-WKHTMLTOPDF
+
+2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
+
+        gem install wkhtmltopdf-binary
+
+
+******************************************************************

data/README.md

@@ -0,0 +1,190 @@
+# MyPDFKit
+
+Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antialize/wkhtmltopdf) on the back-end which renders HTML using Webkit.
+
+## Supported versions
+
+- Ruby 2.5, 2.6, 2.7, 3.0, 3.1
+- Rails 4.2, 5.2, 6.0, 6.1, 7.0
+
+## Install
+
+### MyPDFKit
+```
+gem install my_pdfkit
+```
+### wkhtmltopdf
+
+1. Install by hand (recommended):
+
+    <https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF>
+
+2.  Try using the `wkhtmltopdf-binary-edge` gem (mac + linux i386)
+```
+gem install wkhtmltopdf-binary
+```
+*Note:* The automated installer has been removed.
+
+## Usage
+```ruby
+# MyPDFKit.new takes the HTML and any options for wkhtmltopdf
+# run `wkhtmltopdf --extended-help` for a full list of options
+kit = MyPDFKit.new(html, :page_size => 'Letter')
+kit.stylesheets << '/path/to/css/file'
+
+# Get an inline PDF
+pdf = kit.to_pdf
+
+# Save the PDF to a file
+file = kit.to_file('/path/to/save/pdf')
+
+# MyPDFKit.new can optionally accept a URL or a File.
+# Stylesheets can not be added when source is provided as a URL or File.
+kit = MyPDFKit.new('http://google.com')
+kit = MyPDFKit.new(File.new('/path/to/html'))
+
+# Add any kind of option through meta tags
+MyPDFKit.new('<html><head><meta name="pdfkit-page_size" content="Letter"')
+MyPDFKit.new('<html><head><meta name="pdfkit-cookie cookie_name1" content="cookie_value1"')
+MyPDFKit.new('<html><head><meta name="pdfkit-cookie cookie_name2" content="cookie_value2"')
+```
+
+### Resolving relative URLs and protocols
+
+If the source HTML has relative URLs (`/images/cat.png`) or
+[protocols](https://en.wikipedia.org/wiki/Uniform_Resource_Locator#prurl)
+(`//example.com/site.css`) that need to be resolved, you can pass `:root_url`
+and `:protocol` options to MyPDFKit:
+
+```ruby
+MyPDFKit.new(html, root_url: 'http://mysite.com/').to_file
+# or:
+MyPDFKit.new(html, protocol: 'https').to_file
+```
+
+### Using cookies in scraping
+If you want to pass a cookie to pdfkit to scrape a website, you can
+pass it in a hash:
+```ruby
+kit = MyPDFKit.new(url, cookie: {cookie_name: :cookie_value})
+kit = MyPDFKit.new(url, [:cookie, :cookie_name1] => :cookie_val1, [:cookie, :cookie_name2] => :cookie_val2)
+```
+## Configuration
+If you're on Windows or you would like to use a specific wkhtmltopdf you installed, you will need to tell MyPDFKit where the binary is. MyPDFKit will try to intelligently guess at the location of wkhtmltopdf by running the command `which wkhtmltopdf`. If you are on Windows, want to point MyPDFKit to a different binary, or are having trouble with getting MyPDFKit to find your binary, please manually configure the wkhtmltopdf location. You can configure MyPDFKit like so:
+```ruby
+# config/initializers/pdfkit.rb
+MyPDFKit.configure do |config|
+  config.wkhtmltopdf = '/path/to/wkhtmltopdf'
+  config.default_options = {
+    :page_size => 'Legal',
+    :print_media_type => true
+  }
+  # Use only if your external hostname is unavailable on the server.
+  config.root_url = "http://localhost"
+  config.verbose = false
+end
+```
+## Middleware
+MyPDFKit comes with a middleware that allows users to get a PDF view of any page on your site by appending .pdf to the URL.
+
+### Middleware Setup
+**Non-Rails Rack apps**
+```ruby
+# in config.ru
+require 'my_pdfkit'
+use MyPDFKit::Middleware
+```
+**Rails apps**
+```ruby
+# in application.rb(Rails3) or environment.rb(Rails2)
+require 'pdfkit'
+config.middleware.use MyPDFKit::Middleware
+```
+**With MyPDFKit options**
+```ruby
+# options will be passed to MyPDFKit.new
+config.middleware.use MyPDFKit::Middleware, :print_media_type => true
+```
+**With conditions to limit routes that can be generated in pdf**
+```ruby
+# conditions can be regexps (either one or an array)
+config.middleware.use MyPDFKit::Middleware, {}, :only => %r[^/public]
+config.middleware.use MyPDFKit::Middleware, {}, :only => [%r[^/invoice], %r[^/public]]
+
+# conditions can be strings (either one or an array)
+config.middleware.use MyPDFKit::Middleware, {}, :only => '/public'
+config.middleware.use MyPDFKit::Middleware, {}, :only => ['/invoice', '/public']
+
+# conditions can be regexps (either one or an array)
+config.middleware.use MyPDFKit::Middleware, {}, :except => [%r[^/prawn], %r[^/secret]]
+
+# conditions can be strings (either one or an array)
+config.middleware.use MyPDFKit::Middleware, {}, :except => ['/secret']
+```
+**With conditions to force download**
+```ruby
+# force download with attachment disposition
+config.middleware.use MyPDFKit::Middleware, {}, :disposition => 'attachment'
+# conditions can force a filename
+config.middleware.use MyPDFKit::Middleware, {}, :disposition => 'attachment; filename=report.pdf'
+```
+**Saving the generated .pdf to disk**
+
+Setting the `MyPDFKit-save-pdf` header will cause MyPDFKit to write the generated .pdf to the file indicated by the value of the header.
+
+For example:
+```ruby
+headers['MyPDFKit-save-pdf'] = 'path/to/saved.pdf'
+```
+
+Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent back to the client.  If the path is not writable/non-existent the write will fail silently.  The `MyPDFKit-save-pdf` header is never sent back to the client.
+
+## Troubleshooting
+
+*  **Single thread issue:** In development environments it is common to run a
+   single server process. This can cause issues when rendering your pdf
+   requires wkhtmltopdf to hit your server again (for images, js, css).
+   This is because the resource requests will get blocked by the initial
+   request and the initial request will be waiting on the resource
+   requests causing a deadlock.
+
+   This is usually not an issue in a production environment. To get
+   around this issue you may want to run a server with multiple workers
+   like Passenger or try to embed your resources within your HTML to
+   avoid extra HTTP requests.
+
+   Example solution (rails / bundler), add unicorn to the development
+   group in your Gemfile `gem 'unicorn'` then run `bundle`. Next, add a
+   file `config/unicorn.conf` with
+
+        worker_processes 3
+
+   Then to run the app `unicorn_rails -c config/unicorn.conf` (from rails_root)
+
+*  **Resources aren't included in the PDF:** Images, CSS, or JavaScript
+   does not seem to be downloading correctly in the PDF. This is due
+   to the fact that wkhtmltopdf does not know where to find those files.
+   Make sure you are using absolute paths (start with forward slash) to
+   your resources. If you are using MyPDFKit to generate PDFs from a raw
+   HTML source make sure you use complete paths (either file paths or
+   urls including the domain). In restrictive server environments the
+   root_url configuration may be what you are looking for change your
+   asset host.
+
+*  **Mangled output in the browser:** Be sure that your HTTP response
+   headers specify "content-type: application/pdf"
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Setup your development environment with: `gem install bundler`; `bundle install`
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Jared Pace. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "MyPDFKit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end