THIS PACKAGE HAS BEEN DEPRECATED

Future development has been directed to the idrsolutuions client, which can be used for the same purpose. This package will receive no more updates.

BuildVu Ruby Client

Convert PDF to HTML5 or SVG with Ruby using the BuildVu Ruby Client to interact with IDRsolutions' BuildVu Microservice Example.

The BuildVu Microservice Example is an open source project that allows you to convert PDF to HTML5 or SVG by running BuildVu as a web service in the cloud or on-premise.

IDRsolutions offer a free trial service for running BuildVu with Ruby, more infomation on this can be found here.

---

Installation

Using RubyGems:

Run the following command to install

$ gem install buildvu

Alternatively, add this line to your application's Gemfile...

gem 'buildvu'

...and then execute:

$ bundle install

Building the gem manually:

Run the following command to build the gem locally:

$ gem build buildvu.gemspec

You can then install it using:

$ gem install buildvu  

---

Usage

Basic:

Setup the converter details by creating a new BuildVu object:

require 'buildvu'
buildvu = BuildVu.new('http://localhost:8080/buildvu-microservice')

If your BuildVu service requires authentication, you can provide credentials when you create the BuildVu object:

buildvu = BuildVu.new('http://localhost:8080/buildvu-microservice', auth: {login: 'username', pass: 'password'})

You can now convert files by calling the methods available. convert() will start the conversion process. For example to convert to html5:

# Convert the file with the input method specified
results = buildvu.convert(input: BuildVu::UPLOAD, file: "path/to/file.pdf")

# Return a URL where you can download the converted output
puts results['downloadUrl']

Alternatively, you can specify a url as the input source.

# Convert the file with the input method specified
results = buildvu.convert(input: BuildVu::UPLOAD, url: 'http://link.to/file.pdf')

# Return a URL where you can download the converted output
puts results['downloadUrl']

See additional parameters for convert() at our API.

Once you have converted the file you can also specify a directory to download the converted output to:

# Optionally specify a directory to download the converted output to
buildvu.download_result(conversion_results, 'path/to/output/dir')

See example_usage.rb for examples.

---

Who do I talk to?

Found a bug, or have a suggestion / improvement? Let us know through the Issues page.

Got questions? You can contact us here.

---

Code of Conduct

Short version: Don't be an awful person.

Longer version: Everyone interacting in the BuildVu Ruby Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

---

Copyright 2018 IDRsolutions

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.