https://github.com/tomasc/pdf-rendering-srv-ruby
Simple Ruby wrapper for seding requests to pdf-rendering-srv.
https://github.com/tomasc/pdf-rendering-srv-ruby
Last synced: about 1 month ago
JSON representation
Simple Ruby wrapper for seding requests to pdf-rendering-srv.
- Host: GitHub
- URL: https://github.com/tomasc/pdf-rendering-srv-ruby
- Owner: tomasc
- Created: 2021-05-02T08:45:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-09T15:17:37.000Z (about 5 years ago)
- Last Synced: 2025-10-08T01:47:53.601Z (9 months ago)
- Language: Ruby
- Size: 101 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# pdf-rendering-srv-ruby
[](https://badge.fury.io/rb/pdf-rendering-srv-ruby)
Simple Ruby wrapper for seding requests to [pdf-rendering-srv](https://github.com/restorecommerce/pdf-rendering-srv)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'pdf-rendering-srv-ruby'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install pdf-rendering-srv-ruby
## Usage
Configure the gem by specifying URL of the [pdf-rendering-srv](https://github.com/restorecommerce/pdf-rendering-srv) service:
```ruby
PdfRenderingSrv.configure do |config|
config.pdf_rendering_srv_url = "http://localhost:9000/api/render" # default value
end
```
```ruby
PdfRenderingSrv::FromUrl.call(url: "https://example.com", format: :png, viewport: { width: 800 })
```
```ruby
PdfRenderingSrv::FromHtml.call(html: "Example", format: :pdf, pdf: { format: "A4" })
```
The general interface is described in the [Base](https://github.com/tomasc/pdf-rendering-srv-ruby/blob/master/lib/pdf_rendering_srv/base.rb) class.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tomasc/pdf-rendering-srv-ruby.