grover 0.11.4 → 0.13.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +21 -0
- data/lib/grover.rb +7 -137
- data/lib/grover/configuration.rb +2 -1
- data/lib/grover/errors.rb +18 -0
- data/lib/grover/html_preprocessor.rb +2 -2
- data/lib/grover/js/processor.js +154 -0
- data/lib/grover/middleware.rb +30 -6
- data/lib/grover/options_builder.rb +1 -1
- data/lib/grover/processor.rb +106 -0
- data/lib/grover/version.rb +1 -1
- metadata +10 -17
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ce6455d4d8ede0f5b91972977f8e5d17d8fab13e60096625cd9eb05e759ee8db
|
4
|
+
data.tar.gz: 12484117509a4f5e06bcce9cd39b95f16f105b662ff204f0a0f45b5a22455b51
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b488843267799c52530b27b7a3b8ac8cc76d8767f76062aca8cd32e7560c169d5e8e4d3f4a3498041cd180c4b0487337a51039487846a8a317fb2ecc4499a24a
|
7
|
+
data.tar.gz: fe4681c363d61d1a50fdedd0bbc0d76efa52b5d7990443e0b5fd7f978639a9ee3907b453a54afc3d595f27e85ca0a8d07ea3c91b52784f3f33914c6e1e31b6bc
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2018-2020 Studiosity
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/lib/grover.rb
CHANGED
@@ -5,144 +5,20 @@ require 'grover/version'
|
|
5
5
|
require 'grover/utils'
|
6
6
|
require 'active_support_ext/object/deep_dup' unless defined?(ActiveSupport)
|
7
7
|
|
8
|
+
require 'grover/errors'
|
8
9
|
require 'grover/html_preprocessor'
|
9
10
|
require 'grover/middleware'
|
10
11
|
require 'grover/configuration'
|
11
12
|
require 'grover/options_builder'
|
13
|
+
require 'grover/processor'
|
12
14
|
|
13
15
|
require 'nokogiri'
|
14
|
-
require 'schmooze'
|
15
16
|
require 'yaml'
|
16
17
|
|
17
18
|
#
|
18
19
|
# Grover interface for converting HTML to PDF
|
19
20
|
#
|
20
21
|
class Grover
|
21
|
-
#
|
22
|
-
# Processor helper class for calling out to Puppeteer NodeJS library
|
23
|
-
#
|
24
|
-
class Processor < Schmooze::Base
|
25
|
-
dependencies puppeteer: 'puppeteer'
|
26
|
-
|
27
|
-
def self.launch_params
|
28
|
-
ENV['GROVER_NO_SANDBOX'] == 'true' ? "{args: ['--no-sandbox', '--disable-setuid-sandbox']}" : '{args: []}'
|
29
|
-
end
|
30
|
-
|
31
|
-
def self.convert_function(convert_action)
|
32
|
-
<<~FUNCTION
|
33
|
-
async (url_or_html, options) => {
|
34
|
-
let browser;
|
35
|
-
try {
|
36
|
-
let launchParams = #{launch_params};
|
37
|
-
|
38
|
-
// Configure puppeteer debugging options
|
39
|
-
const debug = options.debug; delete options.debug;
|
40
|
-
if (typeof debug === 'object' && !!debug) {
|
41
|
-
if (debug.headless != undefined) { launchParams.headless = debug.headless; }
|
42
|
-
if (debug.devtools != undefined) { launchParams.devtools = debug.devtools; }
|
43
|
-
}
|
44
|
-
|
45
|
-
// Configure additional launch arguments
|
46
|
-
const args = options.launchArgs; delete options.launchArgs;
|
47
|
-
if (Array.isArray(args)) {
|
48
|
-
launchParams.args = launchParams.args.concat(args);
|
49
|
-
}
|
50
|
-
|
51
|
-
// Set executable path if given
|
52
|
-
const executablePath = options.executablePath; delete options.executablePath;
|
53
|
-
if (executablePath) {
|
54
|
-
launchParams.executablePath = executablePath;
|
55
|
-
}
|
56
|
-
|
57
|
-
// Launch the browser and create a page
|
58
|
-
browser = await puppeteer.launch(launchParams);
|
59
|
-
const page = await browser.newPage();
|
60
|
-
|
61
|
-
// Basic auth
|
62
|
-
const username = options.username; delete options.username
|
63
|
-
const password = options.password; delete options.password
|
64
|
-
if (username != undefined && password != undefined) {
|
65
|
-
await page.authenticate({ username, password });
|
66
|
-
}
|
67
|
-
|
68
|
-
// Setting cookies
|
69
|
-
const cookies = options.cookies; delete options.cookies
|
70
|
-
if (Array.isArray(cookies)) {
|
71
|
-
await page.setCookie(...cookies);
|
72
|
-
}
|
73
|
-
|
74
|
-
// Set caching flag (if provided)
|
75
|
-
const cache = options.cache; delete options.cache;
|
76
|
-
if (cache != undefined) {
|
77
|
-
await page.setCacheEnabled(cache);
|
78
|
-
}
|
79
|
-
|
80
|
-
// Setup timeout option (if provided)
|
81
|
-
let request_options = {};
|
82
|
-
const timeout = options.timeout; delete options.timeout;
|
83
|
-
if (timeout != undefined) {
|
84
|
-
request_options.timeout = timeout;
|
85
|
-
}
|
86
|
-
|
87
|
-
// Setup viewport options (if provided)
|
88
|
-
const viewport = options.viewport; delete options.viewport;
|
89
|
-
if (viewport != undefined) {
|
90
|
-
await page.setViewport(viewport);
|
91
|
-
}
|
92
|
-
|
93
|
-
const waitUntil = options.waitUntil; delete options.waitUntil;
|
94
|
-
if (url_or_html.match(/^http/i)) {
|
95
|
-
// Request is for a URL, so request it
|
96
|
-
request_options.waitUntil = waitUntil || 'networkidle2';
|
97
|
-
await page.goto(url_or_html, request_options);
|
98
|
-
} else {
|
99
|
-
// Request is some HTML content. Use request interception to assign the body
|
100
|
-
request_options.waitUntil = waitUntil || 'networkidle0';
|
101
|
-
await page.setRequestInterception(true);
|
102
|
-
page.once('request', request => {
|
103
|
-
request.respond({ body: url_or_html });
|
104
|
-
// Reset the request interception
|
105
|
-
// (we only want to intercept the first request - ie our HTML)
|
106
|
-
page.on('request', request => request.continue());
|
107
|
-
});
|
108
|
-
const displayUrl = options.displayUrl; delete options.displayUrl;
|
109
|
-
await page.goto(displayUrl || 'http://example.com', request_options);
|
110
|
-
}
|
111
|
-
|
112
|
-
// If specified, emulate the media type
|
113
|
-
const emulateMedia = options.emulateMedia; delete options.emulateMedia;
|
114
|
-
if (emulateMedia != undefined) {
|
115
|
-
if (typeof page.emulateMediaType == 'function') {
|
116
|
-
await page.emulateMediaType(emulateMedia);
|
117
|
-
} else {
|
118
|
-
await page.emulateMedia(emulateMedia);
|
119
|
-
}
|
120
|
-
}
|
121
|
-
|
122
|
-
// If specified, evaluate script on the page
|
123
|
-
const executeScript = options.executeScript; delete options.executeScript;
|
124
|
-
if (executeScript != undefined) {
|
125
|
-
await page.evaluate(executeScript);
|
126
|
-
}
|
127
|
-
|
128
|
-
// If we're running puppeteer in headless mode, return the converted PDF
|
129
|
-
if (debug == undefined || (typeof debug === 'object' && (debug.headless == undefined || debug.headless))) {
|
130
|
-
return await page.#{convert_action}(options);
|
131
|
-
}
|
132
|
-
} finally {
|
133
|
-
if (browser) {
|
134
|
-
await browser.close();
|
135
|
-
}
|
136
|
-
}
|
137
|
-
}
|
138
|
-
FUNCTION
|
139
|
-
end
|
140
|
-
|
141
|
-
method :convert_pdf, convert_function('pdf')
|
142
|
-
method :convert_screenshot, convert_function('screenshot')
|
143
|
-
end
|
144
|
-
private_constant :Processor
|
145
|
-
|
146
22
|
DEFAULT_HEADER_TEMPLATE = "<div class='date text left'></div><div class='title text center'></div>"
|
147
23
|
DEFAULT_FOOTER_TEMPLATE = <<~HTML
|
148
24
|
<div class='url text left grow'></div>
|
@@ -171,10 +47,7 @@ class Grover
|
|
171
47
|
# @return [String] The resulting PDF data
|
172
48
|
#
|
173
49
|
def to_pdf(path = nil)
|
174
|
-
|
175
|
-
return unless result
|
176
|
-
|
177
|
-
result['data'].pack('C*')
|
50
|
+
processor.convert :pdf, @url, normalized_options(path: path)
|
178
51
|
end
|
179
52
|
|
180
53
|
#
|
@@ -186,11 +59,8 @@ class Grover
|
|
186
59
|
#
|
187
60
|
def screenshot(path: nil, format: nil)
|
188
61
|
options = normalized_options(path: path)
|
189
|
-
options['type'] = format if
|
190
|
-
|
191
|
-
return unless result
|
192
|
-
|
193
|
-
result['data'].pack('C*')
|
62
|
+
options['type'] = format if %w[png jpeg].include? format
|
63
|
+
processor.convert :screenshot, @url, options
|
194
64
|
end
|
195
65
|
|
196
66
|
#
|
@@ -200,7 +70,7 @@ class Grover
|
|
200
70
|
# @return [String] The resulting PNG data
|
201
71
|
#
|
202
72
|
def to_png(path = nil)
|
203
|
-
screenshot
|
73
|
+
screenshot path: path, format: 'png'
|
204
74
|
end
|
205
75
|
|
206
76
|
#
|
@@ -210,7 +80,7 @@ class Grover
|
|
210
80
|
# @return [String] The resulting JPEG data
|
211
81
|
#
|
212
82
|
def to_jpeg(path = nil)
|
213
|
-
screenshot
|
83
|
+
screenshot path: path, format: 'jpeg'
|
214
84
|
end
|
215
85
|
|
216
86
|
#
|
data/lib/grover/configuration.rb
CHANGED
@@ -5,13 +5,14 @@ class Grover
|
|
5
5
|
# Configuration of the options for Grover HTML to PDF conversion
|
6
6
|
#
|
7
7
|
class Configuration
|
8
|
-
attr_accessor :options, :meta_tag_prefix, :ignore_path,
|
8
|
+
attr_accessor :options, :meta_tag_prefix, :ignore_path, :root_url,
|
9
9
|
:use_pdf_middleware, :use_png_middleware, :use_jpeg_middleware
|
10
10
|
|
11
11
|
def initialize
|
12
12
|
@options = {}
|
13
13
|
@meta_tag_prefix = 'grover-'
|
14
14
|
@ignore_path = nil
|
15
|
+
@root_url = nil
|
15
16
|
@use_pdf_middleware = true
|
16
17
|
@use_png_middleware = false
|
17
18
|
@use_jpeg_middleware = false
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
class Grover
|
4
|
+
#
|
5
|
+
# Error classes for calling out to Puppeteer NodeJS library
|
6
|
+
#
|
7
|
+
# Heavily based on the Schmooze library https://github.com/Shopify/schmooze
|
8
|
+
#
|
9
|
+
Error = Class.new(StandardError)
|
10
|
+
DependencyError = Class.new(Error)
|
11
|
+
module JavaScript # rubocop:disable Style/Documentation
|
12
|
+
Error = Class.new(::Grover::Error)
|
13
|
+
UnknownError = Class.new(Error)
|
14
|
+
def self.const_missing(name)
|
15
|
+
const_set name, Class.new(Error)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -17,13 +17,13 @@ class Grover
|
|
17
17
|
|
18
18
|
def self.translate_relative_paths(html, root_url)
|
19
19
|
# Try out this regexp using rubular http://rubular.com/r/hiAxBNX7KE
|
20
|
-
html.gsub(%r{(href|src)=(['"])/([^/"']([
|
20
|
+
html.gsub(%r{(href|src)=(['"])/([^/"']([^"']*|[^"']*))?['"]}, "\\1=\\2#{root_url}\\3\\2")
|
21
21
|
end
|
22
22
|
private_class_method :translate_relative_paths
|
23
23
|
|
24
24
|
def self.translate_relative_protocols(body, protocol)
|
25
25
|
# Try out this regexp using rubular http://rubular.com/r/0Ohk0wFYxV
|
26
|
-
body.gsub(%r{(href|src)=(['"])//([
|
26
|
+
body.gsub(%r{(href|src)=(['"])//([^"']*|[^"']*)['"]}, "\\1=\\2#{protocol}://\\3\\2")
|
27
27
|
end
|
28
28
|
private_class_method :translate_relative_protocols
|
29
29
|
end
|
@@ -0,0 +1,154 @@
|
|
1
|
+
// Setup imports
|
2
|
+
try {
|
3
|
+
const Module = require('module');
|
4
|
+
// resolve puppeteer from the CWD instead of where this script is located
|
5
|
+
var puppeteer = require(require.resolve('puppeteer', { paths: Module._nodeModulePaths(process.cwd()) }));
|
6
|
+
} catch (e) {
|
7
|
+
process.stdout.write(JSON.stringify(['err', e.toString()]));
|
8
|
+
process.stdout.write("\n");
|
9
|
+
process.exit(1);
|
10
|
+
}
|
11
|
+
process.stdout.write("[\"ok\"]\n");
|
12
|
+
|
13
|
+
const _processPage = (async (convertAction, urlOrHtml, options) => {
|
14
|
+
let browser;
|
15
|
+
try {
|
16
|
+
const launchParams = {
|
17
|
+
args: process.env.GROVER_NO_SANDBOX === 'true' ? ['--no-sandbox', '--disable-setuid-sandbox'] : []
|
18
|
+
};
|
19
|
+
|
20
|
+
// Configure puppeteer debugging options
|
21
|
+
const debug = options.debug; delete options.debug;
|
22
|
+
if (typeof debug === 'object' && !!debug) {
|
23
|
+
if (debug.headless !== undefined) { launchParams.headless = debug.headless; }
|
24
|
+
if (debug.devtools !== undefined) { launchParams.devtools = debug.devtools; }
|
25
|
+
}
|
26
|
+
|
27
|
+
// Configure additional launch arguments
|
28
|
+
const args = options.launchArgs; delete options.launchArgs;
|
29
|
+
if (Array.isArray(args)) {
|
30
|
+
launchParams.args = launchParams.args.concat(args);
|
31
|
+
}
|
32
|
+
|
33
|
+
// Set executable path if given
|
34
|
+
const executablePath = options.executablePath; delete options.executablePath;
|
35
|
+
if (executablePath) {
|
36
|
+
launchParams.executablePath = executablePath;
|
37
|
+
}
|
38
|
+
|
39
|
+
// Launch the browser and create a page
|
40
|
+
browser = await puppeteer.launch(launchParams);
|
41
|
+
const page = await browser.newPage();
|
42
|
+
|
43
|
+
// Basic auth
|
44
|
+
const username = options.username; delete options.username
|
45
|
+
const password = options.password; delete options.password
|
46
|
+
if (username !== undefined && password !== undefined) {
|
47
|
+
await page.authenticate({ username, password });
|
48
|
+
}
|
49
|
+
|
50
|
+
// Setting cookies
|
51
|
+
const cookies = options.cookies; delete options.cookies
|
52
|
+
if (Array.isArray(cookies)) {
|
53
|
+
await page.setCookie(...cookies);
|
54
|
+
}
|
55
|
+
|
56
|
+
// Set caching flag (if provided)
|
57
|
+
const cache = options.cache; delete options.cache;
|
58
|
+
if (cache !== undefined) {
|
59
|
+
await page.setCacheEnabled(cache);
|
60
|
+
}
|
61
|
+
|
62
|
+
// Setup timeout option (if provided)
|
63
|
+
let requestOptions = {};
|
64
|
+
const timeout = options.timeout; delete options.timeout;
|
65
|
+
if (timeout !== undefined) {
|
66
|
+
requestOptions.timeout = timeout;
|
67
|
+
}
|
68
|
+
|
69
|
+
// Setup viewport options (if provided)
|
70
|
+
const viewport = options.viewport; delete options.viewport;
|
71
|
+
if (viewport !== undefined) {
|
72
|
+
await page.setViewport(viewport);
|
73
|
+
}
|
74
|
+
|
75
|
+
const waitUntil = options.waitUntil; delete options.waitUntil;
|
76
|
+
if (urlOrHtml.match(/^http/i)) {
|
77
|
+
// Request is for a URL, so request it
|
78
|
+
requestOptions.waitUntil = waitUntil || 'networkidle2';
|
79
|
+
await page.goto(urlOrHtml, requestOptions);
|
80
|
+
} else {
|
81
|
+
// Request is some HTML content. Use request interception to assign the body
|
82
|
+
requestOptions.waitUntil = waitUntil || 'networkidle0';
|
83
|
+
await page.setRequestInterception(true);
|
84
|
+
page.once('request', request => {
|
85
|
+
request.respond({ body: urlOrHtml });
|
86
|
+
// Reset the request interception
|
87
|
+
// (we only want to intercept the first request - ie our HTML)
|
88
|
+
page.on('request', request => request.continue());
|
89
|
+
});
|
90
|
+
const displayUrl = options.displayUrl; delete options.displayUrl;
|
91
|
+
await page.goto(displayUrl || 'http://example.com', requestOptions);
|
92
|
+
}
|
93
|
+
|
94
|
+
// If specified, emulate the media type
|
95
|
+
const emulateMedia = options.emulateMedia; delete options.emulateMedia;
|
96
|
+
if (emulateMedia !== undefined) {
|
97
|
+
if (typeof page.emulateMediaType == 'function') {
|
98
|
+
await page.emulateMediaType(emulateMedia);
|
99
|
+
} else {
|
100
|
+
await page.emulateMedia(emulateMedia);
|
101
|
+
}
|
102
|
+
}
|
103
|
+
|
104
|
+
// If specified, evaluate script on the page
|
105
|
+
const executeScript = options.executeScript; delete options.executeScript;
|
106
|
+
if (executeScript !== undefined) {
|
107
|
+
await page.evaluate(executeScript);
|
108
|
+
}
|
109
|
+
|
110
|
+
// If specified, wait for selector
|
111
|
+
const waitForSelector = options.waitForSelector; delete options.waitForSelector;
|
112
|
+
const waitForSelectorOptions = options.waitForSelectorOptions; delete options.waitForSelectorOptions;
|
113
|
+
if (waitForSelector !== undefined) {
|
114
|
+
await page.waitForSelector(waitForSelector, waitForSelectorOptions)
|
115
|
+
}
|
116
|
+
|
117
|
+
// If we're running puppeteer in headless mode, return the converted PDF
|
118
|
+
if (debug === undefined || (typeof debug === 'object' && (debug.headless === undefined || debug.headless))) {
|
119
|
+
return await page[convertAction](options);
|
120
|
+
}
|
121
|
+
} finally {
|
122
|
+
if (browser) {
|
123
|
+
await browser.close();
|
124
|
+
}
|
125
|
+
}
|
126
|
+
});
|
127
|
+
|
128
|
+
function _handleError(error) {
|
129
|
+
if (error instanceof Error) {
|
130
|
+
process.stdout.write(
|
131
|
+
JSON.stringify(['err', error.toString().replace(new RegExp('^' + error.name + ': '), ''), error.name])
|
132
|
+
);
|
133
|
+
} else {
|
134
|
+
process.stdout.write(JSON.stringify(['err', error.toString()]));
|
135
|
+
}
|
136
|
+
process.stdout.write("\n");
|
137
|
+
}
|
138
|
+
|
139
|
+
// Interface for communicating between Ruby processor and Node processor
|
140
|
+
require('readline').createInterface({
|
141
|
+
input: process.stdin,
|
142
|
+
terminal: false,
|
143
|
+
}).on('line', function(line) {
|
144
|
+
try {
|
145
|
+
Promise.resolve(_processPage.apply(null, JSON.parse(line)))
|
146
|
+
.then(function (result) {
|
147
|
+
process.stdout.write(JSON.stringify(['ok', result]));
|
148
|
+
process.stdout.write("\n");
|
149
|
+
})
|
150
|
+
.catch(_handleError);
|
151
|
+
} catch(error) {
|
152
|
+
_handleError(error);
|
153
|
+
}
|
154
|
+
});
|
data/lib/grover/middleware.rb
CHANGED
@@ -9,12 +9,15 @@ class Grover
|
|
9
9
|
# Much of this code was sourced from the PDFKit project
|
10
10
|
# @see https://github.com/pdfkit/pdfkit
|
11
11
|
#
|
12
|
-
class Middleware
|
13
|
-
def initialize(app)
|
12
|
+
class Middleware # rubocop:disable Metrics/ClassLength
|
13
|
+
def initialize(app, *args)
|
14
14
|
@app = app
|
15
15
|
@pdf_request = false
|
16
16
|
@png_request = false
|
17
17
|
@jpeg_request = false
|
18
|
+
|
19
|
+
@root_url =
|
20
|
+
args.last.is_a?(Hash) && args.last.key?(:root_url) ? args.last[:root_url] : Grover.configuration.root_url
|
18
21
|
end
|
19
22
|
|
20
23
|
def call(env)
|
@@ -30,6 +33,8 @@ class Grover
|
|
30
33
|
response = update_response response, headers if grover_request? && html_content?(headers)
|
31
34
|
|
32
35
|
[status, headers, response]
|
36
|
+
ensure
|
37
|
+
restore_env_from_grover_request(env) if grover_request?
|
33
38
|
end
|
34
39
|
|
35
40
|
private
|
@@ -94,12 +99,18 @@ class Grover
|
|
94
99
|
end
|
95
100
|
end
|
96
101
|
|
97
|
-
def create_grover_for_response(response)
|
102
|
+
def create_grover_for_response(response) # rubocop:disable Metrics/AbcSize
|
98
103
|
body = response.respond_to?(:body) ? response.body : response.join
|
99
104
|
body = body.join if body.is_a?(Array)
|
100
|
-
|
101
105
|
body = HTMLPreprocessor.process body, root_url, protocol
|
102
|
-
|
106
|
+
|
107
|
+
options = { display_url: request_url }
|
108
|
+
cookies = Rack::Utils.parse_cookies(env).map do |name, value|
|
109
|
+
{ name: name, value: Rack::Utils.escape(value), domain: env['HTTP_HOST'] }
|
110
|
+
end
|
111
|
+
options[:cookies] = cookies if cookies.any?
|
112
|
+
|
113
|
+
Grover.new(body, options)
|
103
114
|
end
|
104
115
|
|
105
116
|
def add_cover_content(grover)
|
@@ -129,11 +140,24 @@ class Grover
|
|
129
140
|
end
|
130
141
|
|
131
142
|
def configure_env_for_grover_request(env)
|
132
|
-
env
|
143
|
+
# Save the env params we're overriding so we can restore them after the response is fetched
|
144
|
+
@pre_request_env_params = env.slice('PATH_INFO', 'REQUEST_URI', 'HTTP_ACCEPT')
|
145
|
+
|
146
|
+
# Override path/URI so any downstream middleware/app doesn't try actioning the request as PDF
|
147
|
+
env['PATH_INFO'] = path_without_extension
|
148
|
+
env['REQUEST_URI'] = @request.url
|
133
149
|
env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
|
134
150
|
env['Rack-Middleware-Grover'] = 'true'
|
135
151
|
end
|
136
152
|
|
153
|
+
def restore_env_from_grover_request(env)
|
154
|
+
return unless @pre_request_env_params.is_a? Hash
|
155
|
+
|
156
|
+
# Restore the path/URI so any upstream middleware doesn't get confused
|
157
|
+
env.merge! @pre_request_env_params
|
158
|
+
env['REQUEST_URI'] = @request.url unless @pre_request_env_params.key? 'REQUEST_URI'
|
159
|
+
end
|
160
|
+
|
137
161
|
def concat(accepts, type)
|
138
162
|
(accepts || '').split(',').unshift(type).compact.join(',')
|
139
163
|
end
|
@@ -8,7 +8,7 @@ class Grover
|
|
8
8
|
# Build options from Grover.configuration, meta_options, and passed-in options
|
9
9
|
#
|
10
10
|
class OptionsBuilder < Hash
|
11
|
-
def initialize(options, url)
|
11
|
+
def initialize(options, url) # rubocop:disable Lint/MissingSuper
|
12
12
|
@url = url
|
13
13
|
combined = grover_configuration
|
14
14
|
Utils.deep_merge! combined, Utils.deep_stringify_keys(options)
|
@@ -0,0 +1,106 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'json'
|
4
|
+
require 'open3'
|
5
|
+
|
6
|
+
class Grover
|
7
|
+
#
|
8
|
+
# Processor helper class for calling out to Puppeteer NodeJS library
|
9
|
+
#
|
10
|
+
# Heavily based on the Schmooze library https://github.com/Shopify/schmooze
|
11
|
+
#
|
12
|
+
class Processor
|
13
|
+
def initialize(app_root)
|
14
|
+
@app_root = app_root
|
15
|
+
end
|
16
|
+
|
17
|
+
def convert(method, url_or_html, options)
|
18
|
+
spawn_process
|
19
|
+
ensure_packages_are_initiated
|
20
|
+
result = call_js_method method, url_or_html, options
|
21
|
+
return unless result
|
22
|
+
|
23
|
+
result['data'].pack('C*')
|
24
|
+
ensure
|
25
|
+
cleanup_process if stdin
|
26
|
+
end
|
27
|
+
|
28
|
+
private
|
29
|
+
|
30
|
+
attr_reader :app_root, :stdin, :stdout, :stderr, :wait_thr
|
31
|
+
|
32
|
+
def spawn_process
|
33
|
+
@stdin, @stdout, @stderr, @wait_thr = Open3.popen3(
|
34
|
+
'node',
|
35
|
+
File.expand_path(File.join(__dir__, 'js/processor.js')),
|
36
|
+
chdir: app_root
|
37
|
+
)
|
38
|
+
end
|
39
|
+
|
40
|
+
def ensure_packages_are_initiated
|
41
|
+
input = stdout.gets
|
42
|
+
raise Grover::Error, "Failed to instantiate worker process:\n#{stderr.read}" if input.nil?
|
43
|
+
|
44
|
+
result = JSON.parse(input)
|
45
|
+
return if result[0] == 'ok'
|
46
|
+
|
47
|
+
cleanup_process
|
48
|
+
parse_package_error result[1]
|
49
|
+
end
|
50
|
+
|
51
|
+
def parse_package_error(error_message) # rubocop:disable Metrics/MethodLength
|
52
|
+
package_name = error_message[/^Error: Cannot find module '(.*)'$/, 1]
|
53
|
+
raise Grover::Error, error_message unless package_name
|
54
|
+
|
55
|
+
begin
|
56
|
+
%w[dependencies devDependencies].each do |key|
|
57
|
+
next unless package_json.key?(key) && package_json[key].key?(package_name)
|
58
|
+
|
59
|
+
raise Grover::DependencyError, Utils.squish(<<~ERROR)
|
60
|
+
Cannot find module '#{package_name}'.
|
61
|
+
The module was found in '#{package_json_path}' however, please run 'npm install' from '#{app_root}'
|
62
|
+
ERROR
|
63
|
+
end
|
64
|
+
rescue Errno::ENOENT # rubocop:disable Lint/SuppressedException
|
65
|
+
end
|
66
|
+
raise Grover::DependencyError, Utils.squish(<<~ERROR)
|
67
|
+
Cannot find module '#{package_name}'. You need to add it to '#{package_json_path}' and run 'npm install'
|
68
|
+
ERROR
|
69
|
+
end
|
70
|
+
|
71
|
+
def package_json_path
|
72
|
+
@package_json_path ||= File.join(app_root, 'package.json')
|
73
|
+
end
|
74
|
+
|
75
|
+
def package_json
|
76
|
+
@package_json ||= JSON.parse(File.read(package_json_path))
|
77
|
+
end
|
78
|
+
|
79
|
+
def call_js_method(method, url_or_html, options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
|
80
|
+
stdin.puts JSON.dump([method, url_or_html, options])
|
81
|
+
input = stdout.gets
|
82
|
+
raise Errno::EPIPE, "Can't read from worker" if input.nil?
|
83
|
+
|
84
|
+
status, message, error_class = JSON.parse(input)
|
85
|
+
|
86
|
+
if status == 'ok'
|
87
|
+
message
|
88
|
+
elsif error_class.nil?
|
89
|
+
raise Grover::JavaScript::UnknownError, message
|
90
|
+
else
|
91
|
+
raise Grover::JavaScript.const_get(error_class, false), message
|
92
|
+
end
|
93
|
+
rescue JSON::ParserError
|
94
|
+
raise Grover::Error, 'Malformed worker response'
|
95
|
+
rescue Errno::EPIPE, IOError
|
96
|
+
raise Grover::Error, "Worker process failed:\n#{stderr.read}"
|
97
|
+
end
|
98
|
+
|
99
|
+
def cleanup_process
|
100
|
+
stdin.close
|
101
|
+
stdout.close
|
102
|
+
stderr.close
|
103
|
+
wait_thr.join
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
data/lib/grover/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: grover
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.13.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Andrew Bromwich
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-12-05 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: combine_pdf
|
@@ -38,20 +38,6 @@ dependencies:
|
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '1.0'
|
41
|
-
- !ruby/object:Gem::Dependency
|
42
|
-
name: schmooze
|
43
|
-
requirement: !ruby/object:Gem::Requirement
|
44
|
-
requirements:
|
45
|
-
- - "~>"
|
46
|
-
- !ruby/object:Gem::Version
|
47
|
-
version: '0.2'
|
48
|
-
type: :runtime
|
49
|
-
prerelease: false
|
50
|
-
version_requirements: !ruby/object:Gem::Requirement
|
51
|
-
requirements:
|
52
|
-
- - "~>"
|
53
|
-
- !ruby/object:Gem::Version
|
54
|
-
version: '0.2'
|
55
41
|
- !ruby/object:Gem::Dependency
|
56
42
|
name: mini_magick
|
57
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -177,14 +163,18 @@ executables: []
|
|
177
163
|
extensions: []
|
178
164
|
extra_rdoc_files: []
|
179
165
|
files:
|
166
|
+
- LICENSE
|
180
167
|
- lib/active_support_ext/object/deep_dup.rb
|
181
168
|
- lib/active_support_ext/object/duplicable.rb
|
182
169
|
- lib/grover.rb
|
183
170
|
- lib/grover/configuration.rb
|
171
|
+
- lib/grover/errors.rb
|
184
172
|
- lib/grover/html_preprocessor.rb
|
173
|
+
- lib/grover/js/processor.js
|
185
174
|
- lib/grover/middleware.rb
|
186
175
|
- lib/grover/options_builder.rb
|
187
176
|
- lib/grover/options_fixer.rb
|
177
|
+
- lib/grover/processor.rb
|
188
178
|
- lib/grover/utils.rb
|
189
179
|
- lib/grover/version.rb
|
190
180
|
homepage: https://github.com/Studiosity/grover
|
@@ -199,7 +189,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
199
189
|
requirements:
|
200
190
|
- - ">="
|
201
191
|
- !ruby/object:Gem::Version
|
202
|
-
version:
|
192
|
+
version: 2.5.0
|
193
|
+
- - "<"
|
194
|
+
- !ruby/object:Gem::Version
|
195
|
+
version: 2.8.0
|
203
196
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
204
197
|
requirements:
|
205
198
|
- - ">="
|