idr_cloud_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f230aca7d50227ba16e30b2e1f4c6b7bdc066c91eaec6a9c5c4dbcc0d45daf8d
+  data.tar.gz: f4eebdaafdda240052c3030765f5f05560e533a19d8b2d72227de83f26aa0e07
+SHA512:
+  metadata.gz: b750c5e47035580ba78b7b135032a719e3203c6772637fb5f879f8afc594d4abe298d839d96a9033a9e8bdcd1c74aaae5905aeba3ad8d0c79582c51918dd883a
+  data.tar.gz: 68aed215de5869e3a6377db5200f6e47d1f09f8c2135d2a6cb0d07b3bbf163250fe7702c0fc97a0dbddd72c56fe68b6afa0dc037a017cdc7fbb9e49f0879be98

data/.gitattributes

@@ -0,0 +1,9 @@
+# Automatically detect & normalise text files that aren't already specified below
+* text=auto
+
+# Normalise line endings on checkin (set "text" attribute)
+*.in text
+*.cfg text
+*.rst text
+*.md text
+*.rb text

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team [here](https://idrsolutions.zendesk.com/hc/en-us/requests/new). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README-BUILDVU.md

@@ -0,0 +1,82 @@
+# 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](https://github.com/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](https://www.idrsolutions.com/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.](https://www.idrsolutions.com/buildvu/convert-pdf-in-ruby/)
+
+-----
+
+# Usage #
+
+## Basic: (Upload) #
+
+```ruby
+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) #
+```ruby
+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](https://github.com/idrsolutions/buildvu-microservice-example/blob/master/API.md) 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](https://idrsolutions.zendesk.com/hc/en-us/requests/new).
+
+-----
+
+# 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](CODE_OF_CONDUCT.md).
+
+-----
+
+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](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.

data/README-JPEDAL.md

@@ -0,0 +1,82 @@
+# IDRSolutions Ruby Client for JPedal #
+
+Convert PDF to Images with Ruby, using the IDRSolutions Ruby Client to
+interact with IDRsolutions' [JPedal Microservice Example](https://github.com/idrsolutions/jpedal-microservice-example).
+
+The JPedal Microservice Example is an open source project that allows you to
+convert PDF to Images by running [JPedal](https://www.idrsolutions.com/jpedal/) as an online service.
+
+IDR Solutions offer a free trial service for running JPedal with Ruby,
+more information on this can be found [here.](https://www.idrsolutions.com/jpedal/convert-pdf-in-ruby)
+
+-----
+
+# Usage #
+
+## Basic: (Upload) #
+
+```Ruby
+require idr_cloud_client
+client = IDRCloudClient.new('http://localhost:80/' + IDRCloudClient::JPEDAL)
+
+# 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) #
+```Ruby
+require idr_cloud_client
+client = IDRCloudClient.new('http://localhost:80/' + IDRCloudClient::JPEDAL)
+
+# 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](https://github.com/idrsolutions/jpedal-microservice-example/blob/master/API.md) for more details.
+
+See `example_jpedal_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](https://idrsolutions.zendesk.com/hc/en-us/requests/new).
+
+-----
+
+# Code of Conduct #
+
+Short version: Don't be an awful person.
+
+Longer version: Everyone interacting in the JPedal Ruby Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+-----
+
+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](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.

data/README.md

@@ -0,0 +1,80 @@
+# IDRSolutions Ruby Client #
+
+Interact with any [IDRsolutions' Microservice Examples](https://github.com/idrsolutions/) using the IDRSolutions Ruby Client.
+
+The BuildVu Microservice Example is an open source project that allows you to convert PDFs using various softwares from [IDRSolutions](https://www.idrsolutions.com) as an online service.
+
+IDRsolutions offer a free trial service for running these libraries with Ruby. You can find information at the following links for [JPedal](https://www.idrsolutions.com/jpedal/) and [BuildVU](https://www.idrsolutions.com/buildvu/).
+
+-----
+
+# Installation #
+
+## Using RubyGems: ##
+
+Run the following command to install
+
+    $ gem install idr_cloud_client
+
+Alternatively, add this line to your application's Gemfile...
+
+```ruby
+gem 'idr_cloud_client'
+```
+
+...and then execute:
+
+    $ bundle install
+
+## Building the gem manually: ##
+
+Run the following command to build the gem locally:
+
+    $ gem build idr_cloud_client.gemspec
+
+You can then install it using:
+
+    $ gem install idr_cloud_client
+
+-----
+
+# Usage #
+
+## BuildVu: ##
+
+Full usage for connecting to BuildVu can be found [here](README-BUILDVU.md).
+
+## JPedal: ##
+
+Full usage for connecting to JPedal can be found [here](README-JPEDAL.md).
+
+-----
+
+# 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](https://idrsolutions.zendesk.com/hc/en-us/requests/new).
+
+-----
+
+# 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](CODE_OF_CONDUCT.md).  
+
+-----
+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](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.

data/example_buildvu_usage.rb

@@ -0,0 +1,23 @@
+require 'idr_cloud_client'
+
+client = IDRCloudClient.new('http://localhost:80/' + IDRCloudClient::BUILDVU)
+
+# Upload a local file to the BuildVu microservice
+# convert() returns a hash collection with the conversion results.
+conversion_results = client.convert(input: IDRCloudClient::UPLOAD, file: 'path/to/file.pdf')
+
+# You can specify other parameters for the API as named parameters, for example
+# here is the use of the callbackUrl parameter which is a URL that you want to 
+# be updated when the conversion finishes. 
+# See https://github.com/idrsolutions/buildvu-microservice-example/blob/master/API.md
+#conversion_results = client.convert input: IDRCloudClient::UPLOAD, callbackUrl: 'http://listener.url'
+
+# Alternatively, you can specify a url from which the server will download the file to convert.
+#conversion_results = client.convert url: 'http://link.to/filename', input: IDRCloudClient::DOWNLOAD
+
+output_url = conversion_results['downloadUrl']
+
+# After the conversion you can also specify a directory to download the output to:
+#client.download_result conversion_results, 'path/to/output/dir'
+
+puts 'Converted: ' + output_url

data/example_jpedal_usage.rb

@@ -0,0 +1,23 @@
+require 'idr_cloud_client'
+
+client = IDRCloudClient.new('http://localhost:80/' + IDRCloudClient::JPEDAL)
+
+# Upload a local file to the JPedal microservice
+# convert() returns a hash collection with the conversion results.
+conversion_results = client.convert(input: IDRCloudClient::UPLOAD, file: 'path/to/file.pdf')
+
+# You can specify other parameters for the API as named parameters, for example
+# here is the use of the callbackUrl parameter which is a URL that you want to 
+# be updated when the conversion finishes. 
+# See https://github.com/idrsolutions/jpedal-microservice-example/blob/master/API.md
+#conversion_results = client.convert input: IDRCloudClient::UPLOAD, callbackUrl: 'http://listener.url'
+
+# Alternatively, you can specify a url from which the server will download the file to convert.
+#conversion_results = client.convert url: 'http://link.to/filename', input: IDRCloudClient::DOWNLOAD
+
+output_url = conversion_results['downloadUrl']
+
+# After the conversion you can also specify a directory to download the output to:
+#client.download_result conversion_results, 'path/to/output/dir'
+
+puts 'Converted: ' + output_url

data/idr_cloud_client.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'idr_cloud_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'idr_cloud_client'
+  spec.version       = IDRCloudClient::VERSION
+  spec.authors       = ['IDRsolutions']
+  spec.email         = ['support@idrsolutions.zendesk.com']
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+
+  spec.summary       = 'Ruby API for IDRSolutions Microservices'
+  spec.description   = "Convert PDF to HTML5, SVG, or image with Ruby, using the IDR Cloud Client to interact with
+                        IDRsolutions' BuildVu Microservice Example. The Microservice Example is an open source
+                        project that allows you to convert PDF to HTML5, SVG, or image by running BuildVu or JPedal as a web service in the cloud or on-premise. For documentation and usage examples, check out our GitHub page. "
+  spec.homepage      = 'https://github.com/idrsolutions/idrsolutions-ruby-client'
+  spec.license       = 'Apache-2.0'
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 0.17'
+  spec.add_runtime_dependency 'json', '~> 2.1', '>= 2.1'
+end

data/lib/idr_cloud_client.rb

@@ -0,0 +1,171 @@
+#--
+# 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.
+#++
+#
+# Author:: IDRsolutions (mailto:support@idrsolutions.zendesk.com)
+# Copyright:: IDRsolutions
+# License:: Apache 2.0
+
+require 'json'
+require 'Faraday'
+
+
+# Used to interact with IDRsolutions' web services
+# For detailed usage instructions, see GitHub[https://github.com/idrsolutions/IDRSolutions-Ruby-Client]
+class IDRCloudClient
+
+  DOWNLOAD = 'download'
+  UPLOAD = 'upload'
+  JPEDAL = 'jpedal'
+  BUILDVU = 'buildvu'
+
+  @base_endpoint = nil
+  @endpoint = nil
+  @convert_timeout = nil
+  @auth = nil
+
+  # Constructor, setup the converter details
+  # Params:
+  # +url+:: string, the URL of the web service.
+  # +conversion_timeout+:: int, (optional) the time to wait (in seconds) before timing out. Set to 30 by default.
+  # +auth+:: array, (optional) the username and password to use for HTTP Authentication. Set to nil by default
+  def initialize(url, conversion_timeout: 30, auth: nil)
+    @base_endpoint = url
+    @endpoint = @base_endpoint
+    @convert_timeout = conversion_timeout
+    @auth = auth
+  end
+
+  # Converts the given file and returns a hash collection with the conversion results. Requires the 'input' and either 'url' or
+  # 'file' parameters to run. You can then use the values from the hash, or use methods like download_result().
+  # Params:
+  # +input+:: string, the method of inputting a file. Examples are IDRCloudClient::UPLOAD or IDRCloudClient::DOWNLOAD
+  # +file+:: string, (optional) Location of the PDF to convert, i.e 'path/to/input.pdf'
+  # +url+:: string, (optional) the url for the server to download a PDF from
+  #
+  # Returns: hash [string: string], The results of the conversion
+  def convert(**params)
+    uuid = upload params
+
+    response = nil
+    # check conversion status once every second until complete or error / timeout
+    (0..@convert_timeout).each do |i|
+      sleep 1
+      response = poll_status uuid
+
+      break if response['state'] == 'processed'
+
+      break unless params[:callbackUrl].nil?
+
+      if response['state'] == 'error'
+        exMessage = "Failed: Error with conversion\n" 
+        response.each do | key, val |
+          exMessage = exMessage + "#{key}: $#{val}\n" if key != 'state'
+        end
+        raise(exMessage)
+      end
+
+      raise('Failed: File took longer than ' + @convert_timeout.to_s + ' seconds to convert') if i == @convert_timeout
+    end
+
+    response
+  end
+
+  # Downloads the zip file produced by the microservice. Provide '.' as the output_file_path if you wish to use the
+  # current directory. Will use the filename of the zip on the server if none is specified.
+  # Params:
+  # +output_file_path+:: string, the output location to save the zip file
+  # +file_name+:: string, (optional) the custom name for the zip file. This should not include .zip
+  def download_result(results, output_file_path, file_name=nil)
+    download_url = results['downloadUrl']
+
+    raise('Error: downloadUrl parameter is empty') if download_url.nil?
+
+    if file_name.nil?
+      output_file_path += '/' + download_url.split('/').last
+    else
+      output_file_path += '/' + file_name + '.zip'
+    end
+
+    download download_url, output_file_path
+  end
+
+  private
+
+  # Upload file at given path to converter, return UUID if successful
+  def upload(params)
+
+    file_path = params.delete(:file)
+    params[:file] = Faraday::UploadIO.new(file_path, 'application/pdf') if !file_path.nil?
+
+    uri = URI(@endpoint)
+    host = uri.scheme + "://" + uri.host + ':' + uri.port.to_s;
+
+    begin
+      conn = Faraday.new(host) do |f|
+        f.request :multipart
+        f.request :url_encoded
+        f.adapter Faraday.default_adapter
+        f.basic_auth @auth[:login], @auth[:pass] unless @auth.nil?
+      end
+
+      r = conn.post(uri.path, params)
+
+    rescue StandardError => e
+      raise("Error sending url:\n" + e.to_s)
+    end
+
+    raise "Error uploading file:\n Server returned 401 - Unauthorized" if r.status == 401
+    r.status == 200 ? uuid = JSON.parse(r.body)['uuid'] : raise("Error uploading file:\n Server returned response\n" + r.status.to_s + " - " + JSON.parse(r.body)['error'])
+
+    uuid.nil? ? raise("Error uploading file:\nServer returned null UUID") : uuid
+  end
+
+  # Check conversion status
+  def poll_status(uuid)
+    uri = URI(@endpoint)
+    host = uri.scheme + "://" + uri.host + ':' + uri.port.to_s;
+
+    begin
+      conn = Faraday.new(host) do |req|
+          req.params['uuid'] = uuid
+          req.request :url_encoded
+          req.adapter Faraday.default_adapter
+          req.basic_auth @auth[:login], @auth[:pass] unless @auth.nil?
+      end
+      r = conn.get(uri.path)
+    rescue StandardError => e
+      raise("Error checking conversion status:\n" + e.to_s)
+    end
+
+    r.status == 200 ? response = JSON.parse(r.body) : raise("Error checking conversion status:\n Server returned response\n" + r.status.to_s + " - " + JSON.parse(r.body)['error'])
+
+    response
+  end
+
+  # Download converted output to the given location
+  def download(download_url, output_file_path)
+    conn = Faraday.new download_url do |req|
+      req.adapter Faraday.default_adapter
+      req.basic_auth @auth[:login], @auth[:pass] unless @auth.nil?
+    end
+    response = conn.get(download_url)
+    File.open(output_file_path, 'wb') { |fp| fp.write(response.body) }
+
+  rescue StandardError => e
+    raise('Error downloading conversion output: ' + e.to_s)
+  end
+end

data/lib/idr_cloud_client/version.rb

@@ -0,0 +1,3 @@
+class IDRCloudClient
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: idr_cloud_client
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- IDRsolutions
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: "Convert PDF to HTML5, SVG, or image with Ruby, using the IDR Cloud Client
+  to interact with\n                        IDRsolutions' BuildVu Microservice Example.
+  The Microservice Example is an open source\n                        project that
+  allows you to convert PDF to HTML5, SVG, or image by running BuildVu or JPedal as
+  a web service in the cloud or on-premise. For documentation and usage examples,
+  check out our GitHub page. "
+email:
+- support@idrsolutions.zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README-BUILDVU.md
+- README-JPEDAL.md
+- README.md
+- example_buildvu_usage.rb
+- example_jpedal_usage.rb
+- idr_cloud_client.gemspec
+- lib/idr_cloud_client.rb
+- lib/idr_cloud_client/version.rb
+homepage: https://github.com/idrsolutions/idrsolutions-ruby-client
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby API for IDRSolutions Microservices
+test_files: []