IDRSolutions Ruby Client for BuildVu

Convert PDF to HTML5 or SVG with Ruby, using the IDRSolutions 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 an online service.

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

---

Usage

Basic: (Upload)

require idr_cloud_client
client = IDRCloudClient.new('http://localhost:80/' + IDRCloudClient::BUILDVU)

# Convert the file with the input method specified
results = client.convert(input: IDRCloudClient::UPLOAD, file: 'path/to/file.pdf')

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

# Download the converted output to a specified directory:
client.download_result(results, 'path/to/output/dir')

Basic: (Download)

require idr_cloud_client
client = IDRCloudClient.new('http://localhost:80/' + IDRCloudClient::BUILDVU)

# Convert the file with the input method specified
results = client.convert(input: IDRCloudClient::DOWNLOAD, url: 'http://link.to/filename')

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

# Download the converted output to a specified directory:
client.download_result(results, 'path/to/output/dir')

The parameters object should contain the parameters that are sent to the API See the API for more details.

See exampleBuildVuUsage.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 2020 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.