buildvu 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93af82490df9eec79cfc20306dd7be171545665e9fb8b777d20183b93e564b96
-  data.tar.gz: e511e7e1a378acd243922f00409d7a287c942672b0c14990b5e589f8e53cd026
+  metadata.gz: 9c8b9419f655c4e74c509c236a54ff38198811c66403799450eab9998018365d
+  data.tar.gz: ac4f73d748d450cab1418c5cbc7f8cad199fa38d3c223dc9caefcdba17858790
 SHA512:
-  metadata.gz: 25d71aa6847ad20760bbe840e4ed468ef97f96f71b4b472ebf28e96414f38501912f94695714fe571fd70bacbb084b91ea102728ce005163daff06ac4f3751a3
-  data.tar.gz: 417811aba070b68d06d10846cedf552ef6aedcf31f008e1971f5d3861480f281e73d635caffbcdddae76a7c06caedce18b263ec99e5ad52ec1ef1d1425f917c6
+  metadata.gz: 32af19cd10bfab86a2ee869499921723f3d5888ffdbd7d25f80d9f8492e8d16817847638bbbe14c78a0afed2dbff9a3a1b232916f0a314ea523a589ebf609561
+  data.tar.gz: 612e0e8f0ffe61f371428916df691ac37a715ce71e78ed0c21a1d4397fb2a18392d5d2edfd208cafba4f26ccd0e05cb91441e4f3ed3f6a80f1d9cd0b035c9d5f

data/README.md

@@ -46,16 +46,28 @@ require 'buildvu'
 buildvu = BuildVu.new('localhost:8080/microservice-example')
 ```
 
-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
-# returns a URL where you can view the converted output in your web browser
-puts buildvu.convert('/path/to/input/file')
+# Convert the file with the input method specified
+results = buildvu.convert(input: BuildVu::UPLOAD)
 
-# 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 view the converted output in your web browser
+puts results['previewUrl']
+```
+Alternatively, you can specify a url as the input source. This method does not require the prepare_file() method.
+```ruby
+# Convert the file with the input method specified
+results = buildvu.convert(input: BuildVu::UPLOAD, url: 'http://link.to/file.pdf')
 
-# alternatively, you can specify a URL as input instead of uploading a file
-puts buildvu.convert('http://link.to/file.pdf', input_type: BuildVu::DOWNLOAD) 
+# Return a URL where you can view the converted output in your web browser
+puts results['previewUrl']
+```
+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/example_usage.rb

@@ -1,28 +1,23 @@
 require 'buildvu'
 
 buildvu = BuildVu.new'localhost:8080/microservice-example'
-# buildvu = BuildVu.new'https://requestinspector.com/inspect/rf41test'
 
-# convert returns a URL (string) where you can view the converted output.
-# output_url = buildvu.convert 'C:/test/general/ブロッコリ_броколи_ä_é.pdf', output_file_path: 'C:/test/out'
-output_url = buildvu.convert 'C:/test/general/wpgames.pdf', output_file_path: 'C:/test/out'
-# 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'
 
-require 'CGI'
+# 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'
 
-# Encode URI as per RFC-3986
-def encode_uri(uri)
-  CGI::escape uri
-end
+# 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
 
-# Decode URI as per RFC-3986
-def decode_uri(uri)
-  CGI::unescape uri
-end
+output_url = conversion_results['previewUrl']
 
-# filename = encode_uri File.basename('C:/test/general/ブロッコリ.pdf')
-# puts 'RAW: ' + File.basename('C:/test/general/ブロッコリ.pdf')
-# puts 'ENCODED: ' + filename
+# After the conversion you can also specify a directory to download the output to:
+#buildvu.download_result conversion_results, 'path/to/output/dir'
 
-# 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')
+puts 'Converted: ' + output_url

data/lib/buildvu.rb

@@ -19,7 +19,6 @@
 # Copyright:: IDRsolutions
 # License:: Apache 2.0
 
-require 'CGI'
 require 'json'
 require 'rest-client'
 
@@ -44,76 +43,71 @@ class BuildVu
     @convert_timeout = conversion_timeout
   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
     (0..@convert_timeout).each do |i|
       sleep 1
       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'
 
-      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)
+      raise('Failed: File took longer than ' + @convert_timeout.to_s + ' seconds to convert') if i == @convert_timeout
     end
 
-    response['previewUrl']
+    reset_files
+    response
   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
+  # 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
-      raise('Unknown input type\n')
+      output_file_path += '/' + file_name + '.zip' 
     end
+  
+    download download_url, output_file_path
+  end
 
-    # Percent-encode filename
-    filename = encode_uri File.basename(input_file_path)
+  private
 
-    # Debug
-    puts 'INPUT:' + input_file_path
-    puts 'BASENAME: ' + File.basename(input_file_path)
-    puts 'ENCODED: ' + filename
-    # puts 'HEADER: ' + 'Content-Disposition: form-data; name="file"; filename="' + filename + '"'
+  # 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?
 
     begin
-      # r = RestClient.post(@endpoint, {file: file}, {Content_Disposition: 'form-data; name="file"; filename:"' + filename + '"'}) # THIS WORKS?
-      # r = RestClient::Request.execute(method: :post, url: @endpoint, payload: { file: file }, headers: { Content_Disposition: 'form-data; filename:"' + filename + '"', Content_Type: 'application/pdf' })
       r = RestClient.post(@endpoint, params)
     rescue RestClient::ExceptionWithResponse => 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)
+                                                              r.code)
 
     uuid.nil? ? raise('Error uploading file:\nServer returned null UUID') : uuid
   end
@@ -127,7 +121,7 @@ class BuildVu
     end
 
     r.code == 200 ? response = JSON.parse(r.body) : raise('Error checking conversion status:\n Server returned ' +
-                                                              'response\n' + r.code)
+                                                          'response\n' + r.code)
 
     response
   end
@@ -146,13 +140,3 @@ class BuildVu
     raise('Error downloading conversion output: ' + e.to_s)
   end
 end
-
-# Encode URI as per RFC-3986
-def encode_uri(uri)
-  CGI::escape uri
-end
-
-# Decode URI as per RFC-3986
-def decode_uri(uri)
-  CGI::unescape uri
-end

data/lib/buildvu/version.rb

@@ -1,3 +1,3 @@
 class BuildVu
-  VERSION = "2.0.1"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildvu
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Rob Foley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -35,20 +35,20 @@ dependencies:
   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
@@ -94,8 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby API for IDRSolutions BuildVu Microservice