buildvu 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8daba6def01e77256ca5532b78978f463776aa3fb169be97ad07e94abd35cff1
-  data.tar.gz: a594083549ed0d7193d75dc3d377bcb72789cc67a108bbe08f35ea970cda84c1
+SHA1:
+  metadata.gz: 6c2408b72d3639129d60e1fa1c2c66726af876ff
+  data.tar.gz: 5f4360b109b5d33671ce8733f8ac67918682c9cf
 SHA512:
-  metadata.gz: 9cd012f9bfee425cd37bb1fdf881afc0a03f2a81d2b9fa2d2551f27051856a4b61a32800b978903e14de7a7cb850dc4b6ab346a65de83670d25f0a08cdd2f4b5
-  data.tar.gz: 025aa3969b8dafdde558d38914dfdef95b3569a1339554123776c41da1c2919fe08e98d9de9490c3a24fc7460cbea7b1b401acd0771546ec84ac359c6d498de1
+  metadata.gz: 784e32ea71de0a62e67ddfd5d117c3291bffe7ffb500adec67045251b6f2ba19a35bface289e5324d81509fd5801d790490c81e97583b9c885a6d30725d06313
+  data.tar.gz: 60059fb5ba71ba1f094e6fd3e8509671e6edd07e291609ce6f37fef539145bc899891259269a6874e606eb1a6d1a9dfa9d88e833c66f60f4a3d68239a5b1093a

data/README.md

@@ -2,7 +2,7 @@
 
 BuildVu Ruby Client is the Ruby API for IDRSolution's [BuildVu Microservice Example](https://github.com/idrsolutions/buildvu-microservice-example).
 
-It functions as an easy to use, plug and play library that lets you use [BuildVu](https://www.idrsolutions.com/buildvu/) from Ruby. 
+It functions as an easy to use, plug and play library that lets you use [BuildVu](https://www.idrsolutions.com/buildvu/) from Ruby.
 
 -----
 
@@ -10,7 +10,7 @@ It functions as an easy to use, plug and play library that lets you use [BuildVu
 
 ## Using RubyGems: ##
 
-Run the following command to install 
+Run the following command to install
 
     $ gem install buildvu
 
@@ -23,7 +23,7 @@ gem 'buildvu'
 ...and then execute:
 
     $ bundle install
-    
+
 ## Building the gem manually: ##
 
 Run the following command to build the gem locally:
@@ -49,10 +49,11 @@ buildvu = BuildVu.new('localhost:8080/microservice-example')
 You can now convert files by calling `convert`:
 ```ruby
 # returns a URL where you can view the converted output in your web browser
-puts buildvu.convert('/path/to/input/file')
+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.
 
 # you can optionally specify a directory to download the converted output to
-buildvu.convert('/path/to/input/file', '/path/to/output/dir')
+buildvu.convert('/path/to/input/file', output_file_path: '/path/to/output/dir')
 ```
 
 See `example_usage.rb` for examples.
@@ -86,4 +87,4 @@ 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.
+limitations under the License.

data/example_usage.rb

@@ -3,8 +3,10 @@ require 'buildvu'
 buildvu = BuildVu.new'localhost:8080/microservice-example'
 
 # convert returns a URL (string) where you can view the converted output.
-output_url = buildvu.convert 'C:/test/general/%E3%83%96%E3%83%AD%E3%83%83%E3%82%B3%E3%83%AA%E3%83%BC.pdf', 'C:/test/out'
+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
 
 # You can also specify a directory to download the converted output to:
-# buildvu.convert('path/to/input.pdf', 'path/to/output/dir')
+# buildvu.convert('path/to/input.pdf', output_file_path: 'path/to/output/dir')

data/lib/buildvu.rb

@@ -25,6 +25,10 @@ require 'rest-client'
 # Used to interact with IDRsolutions' BuildVu web service
 # For detailed usage instructions, see GitHub[https://github.com/idrsolutions/buildvu-ruby-client]
 class BuildVu
+
+  DOWNLOAD = 'download'
+  UPLOAD = 'upload'
+
   @base_endpoint = nil
   @endpoint = nil
   @convert_timeout = nil
@@ -46,11 +50,10 @@ class BuildVu
   # +output_file_path+:: string, (optional) the directory the output will be saved in, i.e 'path/to/output/dir'
   #
   # Returns: string, the URL where the HTML output can be previewed online
-  def convert(input_file_path, output_file_path = nil)
-    uuid = upload input_file_path
+  def convert(input_file_path, output_file_path: nil, input_type: UPLOAD)
+    uuid = upload input_file_path, input_type
 
     response = nil
-
     # check conversion status once every second until complete or error / timeout
     (0..@convert_timeout).each do |i|
       sleep 1
@@ -77,13 +80,23 @@ class BuildVu
   private
 
   # Upload file at given path to converter, return UUID if successful
-  def upload(input_file_path)
-    file = File.open(input_file_path, 'rb')
+  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
 
     begin
-      r = RestClient.post(@endpoint, file: file)
+      r = RestClient.post(@endpoint, params)
     rescue RestClient::ExceptionWithResponse => e
-      raise('Error uploading file:\n' + e.message)
+      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' +

data/lib/buildvu/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildvu
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - IDRsolutions
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby API for IDRSolutions BuildVu Microservice