DocRaptor Ruby Native Client Library
This is a Ruby gem for using DocRaptor API to convert HTML to PDF and XLSX.
Installation
Add the following to your Gemfile.
gem "docraptor"Then run:
bundle installBasic Usage
DocRaptor.configure do |config|
config.username = "YOUR_API_KEY_HERE" # this key works for test documents
# config.debugging = true
end
$docraptor = DocRaptor::DocApi.new
response = $docraptor.create_doc(
test: true, # test documents are free but watermarked
document_content: "<html><body>Hello World</body></html>", # supply content directly
# document_url: "http://docraptor.com/examples/invoice.html", # or use a url
name: "docraptor-ruby.pdf", # help you find a document later
document_type: "pdf", # pdf or xls or xlsx
# javascript: true, # enable JavaScript processing
# prince_options: {
# media: "screen", # use screen styles instead of print styles
# baseurl: "http://hello.com", # pretend URL when using document_content
# },
)Next Steps
- Optionally store and get a URL for your converted document with document hosting
- View more code examples with error handling, asynchronous creation, file saving, and document hosting.
- Perfect your document styling with our style and formatting reference, and API reference. Easily add headers and footers, page breaks, page numbers, table of contents, and much more!
More Help
Stuck? We're experts at turning HTML into PDFs so please email us if you run into trouble.
Development
The majority of the code in this repo is generated using openapi-generator on docraptor.yaml. You can modify this file and regenerate the client using script/generate_language.
Release Process
- Pull latest master
- Merge feature branch(es) into master
script/test- Increment version:
generator-config.json - Run
script/generate_languageto update generated version numbers:
lib/docraptor/version.rb
- Update CHANGELOG.md
- Commit "Release version vX.Y.Z"
script/release- Verify package release at https://rubygems.org/gems/docraptor
- Refresh documentation on docraptor.com
Version Policy
This library follows Semantic Versioning 2.0.0.