This is a Ruby gem for using DocRaptor API to convert HTML to PDF and XLSX.
Add the following to your Gemfile.
gem "docraptor"Then run:
bundle installSee examples for runnable examples with file output, error handling, etc.
DocRaptor.configure do |dr|
dr.username = "YOUR_API_KEY_HERE" # this key works for test documents
# dr.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
# },
)Docs created like this are limited to 60 seconds to render, check out the async example which allows 10 minutes.
We have guides for doing some of the common things:
- Headers and Footers including page skipping
- CSS Media Selector to make the page look exactly as it does in your browser
- Protect content with HTTP authentication or proxies so only DocRaptor can access them
DocRaptor has a lot of more styling and implementation options.
Stuck? We're experts at using DocRaptor so please email us if you run into trouble.
The majority of the code in this repo is generated using swagger-codegen on docraptor.yaml. You can modify this file and regenerate the client using script/generate_language ruby.
- Pull latest master
- Merge feature branch(es) into master
script/test- Increment version in code:
swagger-config.jsonlib/docraptor/version.rb
- Update CHANGELOG.md
- Commit "Release version vX.Y.Z"
rake release- Verify package release at https://rubygems.org/gems/docraptor
- Refresh documentation on docraptor.com
This library follows Semantic Versioning 2.0.0.