buildvu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7709b66d0f68e6574c3c74be9163a4ff9713b76e830905c8eb9078a8a6d8c9f1
+  data.tar.gz: ebe24a14074fbc26a98824a169674edf08154e468fc029ffd7a1b19890eb1bd3
+SHA512:
+  metadata.gz: 77100ef564a08275aa19d78699eb2bca80929b6fd2c5c375bf983079fefe0200cb7baedcc1f7517c8337ff09e338d0b50a8ae44e5b5753c636dc207bbb3a55e9
+  data.tar.gz: 942e645c08032259065c69bf1ed94651cc2081e41fc499b345265ee546cb9591159441d5e5804a06e3c4b69438b285d5e50c186f15b64547dea9fa4da9f0288f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/bin/
+/doc/
+/exe/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.travis.yml
+/test/
+/Rakefile

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/README.md

@@ -0,0 +1,89 @@
+# BuildVu Ruby Client #
+
+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. 
+
+-----
+
+# Installation #
+
+## Using RubyGems: ##
+
+Run the following command to install 
+
+    $ gem install buildvu
+
+Alternatively, add this line to your application's .gemspec file...
+
+```ruby
+spec.add_runtime_dependency "buildvu"
+```
+
+...and then execute:
+
+    $ bundle install
+    
+## Building the gem manually: ##
+
+Run the following command to build the gem locally:
+
+    $ gem build buildvu.gemspec
+
+You can then install it using:
+
+    $ gem install buildvu  
+
+-----
+
+# Usage #
+
+## Basic: #
+
+Setup the converter details by creating a new `BuildVu` object:
+```ruby
+require 'buildvu'
+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')
+
+# you can optionally specify a directory to download the converted output to
+buildvu.convert('/path/to/input/file', '/path/to/output/dir')
+```
+
+See `example_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 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 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](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/buildvu.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'buildvu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'buildvu'
+  spec.version       = BuildVu::VERSION
+  spec.authors       = ['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   = 'Ruby API for IDRSolutions BuildVu Microservice Example'
+  spec.homepage      = 'https://github.com/idrsolutions/buildvu-ruby-client'
+  spec.license       = 'Apache-2.0'
+
+  spec.required_ruby_version = '>= 2.0.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_development_dependency 'bundler', '~> 1.16', '>= 1.16.1'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+  spec.add_runtime_dependency 'json', '~> 2.1', '>= 2.1'
+end

data/example_usage.rb

@@ -0,0 +1,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/awjune2003.pdf', 'C:\\test\\out\\'
+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')

data/lib/buildvu.rb

@@ -0,0 +1,120 @@
+#--
+# 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 '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
+  @base_endpoint = nil
+  @endpoint = nil
+  @convert_timeout = 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)
+    @base_endpoint = url
+    @endpoint = @base_endpoint + '/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.
+  # 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'
+  #
+  # 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
+
+    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'
+
+      raise('Error checking conversion status') 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 = @base_endpoint + '/' + response['downloadPath']
+      # 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)
+    end
+
+    @base_endpoint + '/' + response['previewPath']
+  end
+
+  private
+
+  # Upload file at given path to converter, return UUID if successful
+  def upload(input_file_path)
+    file = File.open(input_file_path, 'rb')
+
+    begin
+      r = RestClient.post(@endpoint, file: file)
+    rescue RestClient::ExceptionWithResponse => e
+      raise('Error uploading file:\n' + e.message)
+    end
+
+    r.code == 200 ? uuid = JSON.parse(r.body)['uuid'] : raise('Error uploading file')
+
+    uuid
+  end
+
+  # Check conversion status
+  def poll_status(uuid)
+    begin
+      r = RestClient.get(@endpoint + '?uuid=' + uuid)
+    rescue RestClient::ExceptionWithResponse => e
+      raise('Error checking conversion status:\n' + e.to_s)
+    end
+
+    r.code == 200 ? response = JSON.parse(r.body) : raise('Error checking conversion status')
+
+    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
+    end
+  rescue RestClient::ExceptionWithResponse => e
+    raise('Error downloading conversion output: ' + e.to_s)
+  end
+end

data/lib/buildvu/version.rb

@@ -0,0 +1,3 @@
+class BuildVu
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: buildvu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IDRsolutions
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  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
+- !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: Ruby API for IDRSolutions BuildVu Microservice Example
+email:
+- support@idrsolutions.zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- buildvu.gemspec
+- example_usage.rb
+- lib/buildvu.rb
+- lib/buildvu/version.rb
+homepage: https://github.com/idrsolutions/buildvu-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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby API for IDRSolutions BuildVu Microservice
+test_files: []