buildvu 2.0.0 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6c2408b72d3639129d60e1fa1c2c66726af876ff
-  data.tar.gz: 5f4360b109b5d33671ce8733f8ac67918682c9cf
+SHA256:
+  metadata.gz: 0a050414fcce6b74e5c134a4fabc5c87cd319961b029f67813abedd4bad30dd8
+  data.tar.gz: 0572ce858a12304777d2823e1b9e982dea4a11b44eec1a3b20bd51874bbcb4cb
 SHA512:
-  metadata.gz: 784e32ea71de0a62e67ddfd5d117c3291bffe7ffb500adec67045251b6f2ba19a35bface289e5324d81509fd5801d790490c81e97583b9c885a6d30725d06313
-  data.tar.gz: 60059fb5ba71ba1f094e6fd3e8509671e6edd07e291609ce6f37fef539145bc899891259269a6874e606eb1a6d1a9dfa9d88e833c66f60f4a3d68239a5b1093a
+  metadata.gz: b9177aa5d193e0388a3f1eab60796ba99e9e97a52748671beb0f1560a660797cc10a3069837f83bf744ed5b5eded748821717143abf4dec90fd457fb869574a6
+  data.tar.gz: ed96b17b340123e3ab4fc5695b864570f31da9a6df582064da68124c4b01bd0805f97e88834d153c255c55d21dc0a07de0e67a507395c6593d5ef9639947f78f

data/README.md

@@ -1,8 +1,13 @@
+# THIS PACKAGE HAS BEEN DEPRECATED #
+Future development has been directed to the [idrsolutuions client](https://github.com/idrsolutions/idrsolutions-ruby-client), which can be used for the same purpose. This package will receive no more updates. 
+
 # BuildVu Ruby Client #
 
-BuildVu Ruby Client is the Ruby API for IDRSolution's [BuildVu Microservice Example](https://github.com/idrsolutions/buildvu-microservice-example).
+Convert PDF to HTML5 or SVG with Ruby using the BuildVu 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 a web service in the cloud or on-premise.
 
-It functions as an easy to use, plug and play library that lets you use [BuildVu](https://www.idrsolutions.com/buildvu/) from Ruby.
+IDRsolutions 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/).
 
 -----
 
@@ -43,17 +48,38 @@ You can then install it using:
 Setup the converter details by creating a new `BuildVu` object:
 ```ruby
 require 'buildvu'
-buildvu = BuildVu.new('localhost:8080/microservice-example')
+buildvu = BuildVu.new('http://localhost:8080/buildvu-microservice')
+```
+
+If your BuildVu service requires authentication, you can provide credentials when you create the `BuildVu` object:
+
+```ruby
+buildvu = BuildVu.new('http://localhost:8080/buildvu-microservice', auth: {login: 'username', pass: 'password'})
 ```
 
-You can now convert files by calling `convert`:
+
+You can now convert files by calling the methods available. `convert()` will start the conversion process. For example to convert to html5:
+```ruby
+# 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.
 ```ruby
-# returns a URL where you can view the converted output in your web browser
-puts buildvu.convert('/path/to/input/file') # File upload
-puts buildvu.convert('http://link.to/file.pdf', input_type: "download") # Send url pointing to file to server.
+# Convert the file with the input method specified
+results = buildvu.convert(input: BuildVu::UPLOAD, url: 'http://link.to/file.pdf')
 
-# you can optionally specify a directory to download the converted output to
-buildvu.convert('/path/to/input/file', output_file_path: '/path/to/output/dir')
+# Return a URL where you can download the converted output
+puts results['downloadUrl']
+```
+See additional parameters for `convert()` at our [API](https://github.com/idrsolutions/buildvu-microservice-example/blob/master/API.md).
+ 
+Once you have converted the file you can also specify a directory to download the converted output to:
+```ruby
+# 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.

data/buildvu.gemspec

@@ -5,18 +5,21 @@ require 'buildvu/version'
 Gem::Specification.new do |spec|
   spec.name          = 'buildvu'
   spec.version       = BuildVu::VERSION
-  spec.authors       = ['IDRsolutions']
+  spec.authors       = ['Rob Foley', 'IDRsolutions']
   spec.email         = ['support@idrsolutions.zendesk.com']
   spec.date          = Time.now.strftime('%Y-%m-%d')
 
-  spec.summary       = 'Ruby API for IDRSolutions BuildVu Microservice'
-  spec.description   = "The BuildVu Ruby Client is the Ruby API for IDRsolutions' BuildVu Microservice Example, an open
-                        source project that allows you to convert PDF to HTML5 by running BuildVu as an online service.
-                        For documentation and usage examples, check out our GitHub page."
+  spec.summary       = '[DEPRECATED] Ruby API for IDRSolutions BuildVu Microservice'
+  spec.description   = "Future development has been directed to idrsolutions-ruby-client, which can be used for the same purpose. 
+                        This package will receive no more updates. 
+                        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. For documentation and usage examples, check out our GitHub page. "
   spec.homepage      = 'https://github.com/idrsolutions/buildvu-ruby-client'
   spec.license       = 'Apache-2.0'
 
-  spec.required_ruby_version = '>= 2.0.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)/})
@@ -25,6 +28,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+  spec.add_runtime_dependency 'faraday', '~> 0.17'
   spec.add_runtime_dependency 'json', '~> 2.1', '>= 2.1'
 end

data/example_usage.rb

@@ -1,12 +1,23 @@
 require 'buildvu'
 
-buildvu = BuildVu.new'localhost:8080/microservice-example'
+buildvu = BuildVu.new'localhost:8080/buildvu-microservice'
 
-# convert returns a URL (string) where you can view the converted output.
-output_url = buildvu.convert 'path/to/file.pdf'
-# Or alternatively: to upload a url pointing to a pdf file with:
-# output_url = buildvu.convert 'path/to/file.pdf', input_type: BuildVu::DOWNLOAD
-puts 'Converted: ' + output_url
+# Upload a local file to the BuildVu microservice
+# convert() returns a hash collection with the conversion results.
+conversion_results = buildvu.convert input: BuildVu::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 = buildvu.convert input: BuildVu::UPLOAD, callbackUrl: 'http://listener.url'
+
+# Alternatively, you can specify a url from which the server will download the file to convert.
+#conversion_results = buildvu.convert url: 'http://link.to/filename', input: BuildVu::DOWNLOAD
 
-# You can also specify a directory to download the converted output to:
-# buildvu.convert('path/to/input.pdf', output_file_path: 'path/to/output/dir')
+output_url = conversion_results['downloadUrl']
+
+# After the conversion you can also specify a directory to download the output to:
+#buildvu.download_result conversion_results, 'path/to/output/dir'
+
+puts 'Converted: ' + output_url

data/lib/buildvu.rb

@@ -20,7 +20,8 @@
 # License:: Apache 2.0
 
 require 'json'
-require 'rest-client'
+require 'Faraday'
+
 
 # Used to interact with IDRsolutions' BuildVu web service
 # For detailed usage instructions, see GitHub[https://github.com/idrsolutions/buildvu-ruby-client]
@@ -32,26 +33,30 @@ class BuildVu
   @base_endpoint = nil
   @endpoint = nil
   @convert_timeout = nil
+  @auth = nil
 
   # Constructor, setup the converter details
   # Params:
   # +url+:: string, the URL of the BuildVu web service.
   # +conversion_timeout+:: int, (optional) the time to wait (in seconds) before timing out. Set to 30 by default.
-  def initialize(url, conversion_timeout = 30)
+  # +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 + '/buildvu'
     @convert_timeout = conversion_timeout
+    @auth = auth
   end
 
-  # Converts the given file and returns the URL where the output can be previewed online. If the output_file_path
-  # parameter is also passed in, a copy of the output will be downloaded to the specified location.
+  # 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_file_path+:: string, the location of the PDF to convert, i.e 'path/to/input.pdf'
-  # +output_file_path+:: string, (optional) the directory the output will be saved in, i.e 'path/to/output/dir'
+  # +input+:: string, the method of inputting a file. Examples are BuildVu::UPLOAD or BuildVu::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: string, the URL where the HTML output can be previewed online
-  def convert(input_file_path, output_file_path: nil, input_type: UPLOAD)
-    uuid = upload input_file_path, input_type
+  # 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
@@ -61,75 +66,98 @@ class BuildVu
 
       break if response['state'] == 'processed'
 
+      break unless params[:callbackUrl].nil?
+
       raise('Server error getting conversion status, see server logs for details') if response['state'] == 'error'
 
       raise('Failed: File took longer than ' + @convert_timeout.to_s + ' seconds to convert') if i == @convert_timeout
     end
 
-    # download output
-    unless output_file_path.nil?
-      download_url = response['downloadUrl']
-      # get filename from input_file_path (downloaded file will be [filename].zip)
-      output_file_path += '/' + File.basename(input_file_path)[0..-4] + 'zip'
-      download(download_url, output_file_path)
+    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
 
-    response['previewUrl']
+    download download_url, output_file_path
   end
 
   private
 
   # Upload file at given path to converter, return UUID if successful
-  def upload(input_file_path, input_type)
-    params = {:input => input_type}
-
-    case input_type
-    when UPLOAD
-      file = File.open(input_file_path, 'rb')
-      params[:file] = file
-    when DOWNLOAD
-      params[:url] = input_file_path
-    else
-      raise('Unknown input type\n')
-    end
+  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
-      r = RestClient.post(@endpoint, params)
-    rescue RestClient::ExceptionWithResponse => e
-      raise('Error sending url:\n' + e.to_s)
+      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
 
-    r.code == 200 ? uuid = JSON.parse(r.body)['uuid'] : raise('Error uploading file:\n Server returned response\n' +
-                                                                  r.code)
+    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
+    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
-      r = RestClient.get(@endpoint + '?uuid=' + uuid)
-    rescue RestClient::ExceptionWithResponse => e
-      raise('Error checking conversion status:\n' + e.to_s)
+      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.code == 200 ? response = JSON.parse(r.body) : raise('Error checking conversion status:\n Server returned ' +
-                                                              'response\n' + r.code)
+    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)
-    File.open(output_file_path, 'wb') do |output_file|
-      block = lambda { |r|
-        r.read_body do |data|
-          output_file.write data
-        end
-      }
-      RestClient::Request.new(method: :get, url: download_url, block_response: block).execute
+    conn = Faraday.new download_url do |req|
+      req.adapter Faraday.default_adapter
+      req.basic_auth @auth[:login], @auth[:pass] unless @auth.nil?
     end
-  rescue RestClient::ExceptionWithResponse => e
+    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/buildvu/version.rb

@@ -1,3 +1,3 @@
 class BuildVu
-  VERSION = "2.0.0"
+  VERSION = "3.1.4"
 end

metadata

@@ -1,59 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: buildvu
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.1.4
 platform: ruby
 authors:
+- Rob Foley
 - IDRsolutions
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        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: |-
-  The BuildVu Ruby Client is the Ruby API for IDRsolutions' BuildVu Microservice Example, an open
-                          source project that allows you to convert PDF to HTML5 by running BuildVu as an online service.
-                          For documentation and usage examples, check out our GitHub page.
+description: "Future development has been directed to idrsolutions-ruby-client, which
+  can be used for the same purpose. \n                        This package will receive
+  no more updates. \n                        Convert PDF to HTML5 or SVG with Ruby,
+  using the BuildVu Ruby Client to interact with\n                        IDRsolutions'
+  BuildVu Microservice Example. The BuildVu Microservice Example is an open source\n
+  \                       project that allows you to convert PDF to HTML5 or SVG by
+  running BuildVu as a web service in\n                        the cloud or on-premise.
+  For documentation and usage examples, check out our GitHub page. "
 email:
 - support@idrsolutions.zendesk.com
 executables: []
@@ -84,16 +83,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Ruby API for IDRSolutions BuildVu Microservice
+summary: "[DEPRECATED] Ruby API for IDRSolutions BuildVu Microservice"
 test_files: []