Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
By Socket Research Team - Dec 02, 2024
Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Dhalang
- 0.7.1
- Rubygems
Dhalang 
Dhalang is a Ruby wrapper for Google's Puppeteer.
Features
- Generate PDFs from webpages
- Generate PDFs from HTML ( external images/stylesheets supported )
- Capture screenshots from webpages
- Scrape HTML from webpages
Prerequisites
- Node ≥ 18
- Puppeteer ≥ 22
- Unix shell ( Dhalang will not work on Windows shells )
Installation
Add this line to your application's Gemfile:
gem 'Dhalang'
And then execute:
$ bundle update
Install puppeteer or puppeteer-core in your application's root directory:
$ npm install puppeteer
or
$ npm install puppeteer-core
Usage
PDF of a website url
Dhalang::PDF.get_from_url("https://www.google.com")
It is important to pass the complete url, leaving out https://, http:// or www. will result in an error.
PDF of a HTML string
Dhalang::PDF.get_from_html("<html><head></head><body><h1>examplestring</h1></body></html>")
PNG screenshot of a website
Dhalang::Screenshot.get_from_url("https://www.google.com", :png)
JPEG screenshot of a website
Dhalang::Screenshot.get_from_url("https://www.google.com", :jpeg)
WEBP screenshot of a website
Dhalang::Screenshot.get_from_url("https://www.google.com", :webp)
HTML of a website
Dhalang::Scraper.html("https://www.google.com")
Above methods either return a string containing the PDF/JPEG/PNG/WEBP in binary or the scraped HTML.
Custom options
To override the default options that are set by Dhalang you can pass as last argument a hash with the custom options you want to set.
For example to set custom margins for PDFs:
Dhalang::PDF.get_from_url("https://www.google.com", {margin: { top: 100, right: 100, bottom: 100, left: 100}})
For example to only take a screenshot of the visible part of the page:
Dhalang::Screenshot.get_from_url("https://www.google.com", :webp, {fullPage: false})
A list of all possible PDF options that can be set, can be found at: https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions
A list of all possible screenshot options that can be set, can be found at: https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagescreenshotoptions
The default Puppeteer options contain the options
headerTemplateandfooterTemplate. Puppeteer expects these to be HTML strings. By default, the Dhalang gem passes all options as arguments in anode ...shell command. In case the HTML strings are too long they might surpass the maximum argument length of the host. For example, on Linux theMAX_ARG_LENis 128kB. Therefore, you can also pass the headers and footers as file path using the optionsheaderTemplateFileandfooterTemplateFile. These non-Puppeteer-options will be used to populate the Puppeteer-optionsheaderTemplateandfooterTemplate.For example:
Dhalang::PDF.get_from_url("https://www.google.com", {headerTemplateFile: '/tmp/header.html', footerTemplateFile: '/tmp/footer.html'})
Below table lists more configuration parameters that can be set:
| Key | Description | Default |
|---|---|---|
| browserWebsocketUrl | Websocket url of remote chromium browser to use | None |
| navigationTimeout | Amount of milliseconds until Puppeteer while timeout when navigating to the given page | 10000 |
| printToPDFTimeout | Amount of milliseconds until Puppeteer while timeout when calling Page.printToPDF | 0 (unlimited) |
| navigationWaitForSelector | If set, Dhalang will wait for the specified selector to appear before creating the screenshot or PDF | None |
| navigationWaitForXPath | If set, Dhalang will wait for the specified XPath to appear before creating the screenshot or PDF | None |
| userAgent | User agent to send with the request | Default Puppeteer one |
| isHeadless | Indicates if Chromium should be launched headless | true |
| isAutoHeight | When set to true the height of generated PDFs will be based on the scrollHeight property of the document body | false |
| viewPort | Custom viewport to use for the request | Default Puppeteer one |
| httpAuthenticationCredentials | Custom HTTP authentication credentials to use for the request | None |
| chromeOptions | A array of options that can be passed to puppeteer in addition to the mandatory ['--no-sandbox', '--disable-setuid-sandbox'] | [] |
Examples of using Dhalang
To return a PDF from a Rails controller you can do the following:
def example_controller_method
binary_pdf = Dhalang::PDF.get_from_url("https://www.google.com")
send_data(binary_pdf, filename: 'pdfofgoogle.pdf', type: 'application/pdf')
end
To return a screenshot from a Rails controller you can do the following:
def example_controller_method
binary_png = Dhalang::Screenshot.get_from_url("https://www.google.com", :png)
send_data(binary_png, filename: 'screenshotofgoogle.png', type: 'image/png')
end
FAQs
Unknown package
We found that Dhalang demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Package last updated on 11 Aug 2024
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Research
Typosquatting Cryptographic Libraries: Malicious npm Packages Threaten Crypto Developers with Keylogging and Wallet Theft
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
By Kirill Boychenko - Nov 27, 2024
Security News
Weekly Downloads Now Available in npm Package Search Results
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
By Sarah Gooding - Nov 26, 2024