buildvu 3.0.1 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 596d7ac9d31dcd3fe525fdecae64df05845eb9cd
-  data.tar.gz: a230a0f3fa2ddeb9fda5a9e88386d56db6024043
+SHA256:
+  metadata.gz: 2736428d3a17ab25da60ecb457f7c12bc082f7abeb76c90a3a5f2916a6456913
+  data.tar.gz: 4ff8b3bbe028c40134d1be7193f84fea2a9b63ad06ed20b2bc652ba08081e6df
 SHA512:
-  metadata.gz: 11f28cb021db265b6a23fa53c13cc0ae7dcc70d50b0a74292c0b3df24110e0c335f03d6c60407e134dd1e40e8d94abb49fbd79259aeeba3a8c62680d59a720f1
-  data.tar.gz: 4025e542479fc1a612bf0929c8c5e49801838557305623c985314ed9855272c095e927016ae3412632ba2fb9ee03a99fed4491eba6d23d74671c1cbebfa3e095
+  metadata.gz: 83a0521c1003437e9fb0c42150f0087a00d37ea88b37e64a524a63c8a22f55b71758762daaa0dd108aec6a74e3e9fb129cb23f4154f7a9ae0ca6fd00021b51be
+  data.tar.gz: ea0ff7ecb21520422121b935cee631f05815482502175224d94c72ea627192663752dec81c3d3b795a20fb144c852f1cde425b6c00eb13ae012a9d8a78c6e1f4

data/README.md

@@ -4,6 +4,8 @@ Convert PDF to HTML5 or SVG with Ruby using the BuildVu Ruby Client to interact
 
 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.
 
+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/).
+
 -----
 
 # Installation #
@@ -43,24 +45,31 @@ 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 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 view the converted output in your web browser
-puts results['previewUrl']
+# Return a URL where you can download the converted output
+puts results['downloadUrl']
 ```
 Alternatively, you can specify a url as the input source.
 ```ruby
 # 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 view the converted output in your web browser
-puts results['previewUrl']
+# 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).
  

data/buildvu.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   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)/})
@@ -26,6 +26,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,6 +1,6 @@
 require 'buildvu'
 
-buildvu = BuildVu.new'localhost:8080/microservice-example'
+buildvu = BuildVu.new'localhost:8080/buildvu-microservice'
 
 # Upload a local file to the BuildVu microservice
 # convert() returns a hash collection with the conversion results.
@@ -15,7 +15,7 @@ conversion_results = buildvu.convert input: BuildVu::UPLOAD, file: 'path/to/file
 # 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
 
-output_url = conversion_results['previewUrl']
+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'

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,18 +33,21 @@ 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 a hash collection with the conversion results. Requires the 'input' and either 'url' or 
+  # 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 BuildVu::UPLOAD or BuildVu::DOWNLOAD
@@ -61,7 +65,7 @@ class BuildVu
       response = poll_status uuid
 
       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'
@@ -72,22 +76,22 @@ class BuildVu
     response
   end
 
-  # Downloads the zip file produced by the microservice. Provide '.' as the output_file_path if you wish to use the 
+  # 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' 
+      output_file_path += '/' + file_name + '.zip'
     end
-  
+
     download download_url, output_file_path
   end
 
@@ -95,47 +99,65 @@ class BuildVu
 
   # Upload file at given path to converter, return UUID if successful
   def upload(params)
-    
-    file_path = params.delete(:file);
-    params[:file] = File.open(file_path, 'rb') if !file_path.nil?
+
+    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
+      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
   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
+      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 = "3.0.1"
+  VERSION = "3.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildvu
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.3
 platform: ruby
 authors:
 - Rob Foley
@@ -9,46 +9,40 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-12-18 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: "Convert PDF to HTML5 or SVG with Ruby, using the BuildVu Ruby Client
@@ -87,15 +81,14 @@ 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