docraptor 1.4.0 → 3.0.0

data/script/swagger

@@ -2,39 +2,12 @@
 set -e
 cd "$(dirname "$0")/.."
 
-SWAGGER_CODGEN_REVISION=$(cat .swagger-revision 2> /dev/null || true)
-if [ "$SWAGGER_CODGEN_REVISION" = "" ]; then
-  echo "Set a revision of swagger-codegen to use in .swagger-revision"
-  exit 1
-fi
+set -x
 
-if ! [ -x "$(command -v mvn)" ]; then
-  echo 'Error: mvn not installed, using homebrew to install' >&2
-  brew install maven
-fi
-
-if [ ! -d "swagger-codegen" ]; then
-  git clone https://github.com/swagger-api/swagger-codegen
-fi
-
-(
-  cd swagger-codegen
-  if [[ "${#SWAGGER_CODGEN_REVISION}" -lt 40 ]]; then
-    # resolve git tags / branch names
-    SWAGGER_CODGEN_REVISION=$(git show "$SWAGGER_CODGEN_REVISION" --format="%H")
-  fi
-  if [[ $(cat .git/HEAD) != "$SWAGGER_CODGEN_REVISION" ]]; then
-    git fetch
-    git checkout "$SWAGGER_CODGEN_REVISION"
-    mvn clean package
-  fi
-)
-
-executable="./swagger-codegen/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
-
-if [ ! -f "$executable" ]; then
-  mvn clean package
+GENERATOR_REVISION=$(cat .generator-revision 2> /dev/null || true)
+if [ "$GENERATOR_REVISION" = "" ]; then
+  echo "Set a revision of openapi-generator to use in .generator-revision"
+  exit 1
 fi
 
-export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties -DapiTests=false -DapiDocs=false -DmodelTests=false -DmodelDocs=false"
-java $JAVA_OPTS -jar $executable $*
+docker run -it -w "/local" --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:"${GENERATOR_REVISION}" "$@"

data/script/test

@@ -1,24 +1,58 @@
-#!/bin/sh
+#!/bin/bash
 set -e
-cd "`dirname \"$0\"`/.."
+[[ "$TRACE" == "true" ]] && set -x
+cd "$(dirname "$0")/.."
 
-# check dependencies
-ruby -v > /dev/null    || (echo "ruby must be installed"; exit 1)
-bundler -v > /dev/null || (echo "bundler must be installed"; exit 1)
+echo "Clearing test output directory"
+rm -rf tmp/test_output/
+mkdir -p tmp/test_output
 
-bundle install
+[ -f script/build ] && script/build
 
-cd test
-
-# runs a test file with PASS/FAIL message
-run_test() {
-  ruby $1 && echo "PASS $1" || (echo "FAIL $1"; exit 1)
+run_tests() {
+  runtime_env="$1"
+  if time script/docker -i "$runtime_env" /app/script/inside_container/test; then
+    tput bold    # bold text
+    tput setaf 2 # green text
+    echo "======================================"
+    echo "$runtime_env Passed"
+    echo "======================================"
+    tput sgr0    # reset to default text
+    return 0
+  else
+    tput bold    # bold text
+    tput setaf 1 # red text
+    echo "======================================"
+    echo "$runtime_env FAILED"
+    echo "======================================"
+    tput sgr0    # reset to default text
+    return 1
+  fi
 }
 
-if [ "$1" == "" ]; then
-  for test in $(ls *.rb); do
-    run_test $test
-  done
+success="true"
+
+for runtime_env in $(cat .runtime-environments | grep -v '^#'); do
+  echo
+  echo
+  echo "Testing runtime env $runtime_env"
+  run_tests "$runtime_env" || success="false"
+done
+
+if [ $success == "true" ]; then
+  tput bold    # bold text
+  tput setaf 2 # green text
+  echo "======================================"
+  echo "=      Full Test Suite Passed        ="
+  echo "======================================"
+  tput sgr0    # reset to default text
+  exit 0
 else
-  run_test $1.rb
+  tput bold    # bold text
+  tput setaf 1 # red text
+  echo "======================================"
+  echo "=      Full Test Suite FAILED        ="
+  echo "======================================"
+  tput sgr0    # reset to default text
+  exit 1
 fi

data/test/async.rb

@@ -8,7 +8,8 @@ end
 
 $docraptor = DocRaptor::DocApi.new
 
-output_file = "ruby-async.pdf"
+test_output_dir = File.join(File.dirname(File.expand_path(__FILE__)), "..", "tmp", "test_output")
+output_file = File.join(test_output_dir, "#{File.basename(__FILE__, ".rb")}_ruby_#{RUBY_VERSION}.pdf")
 
 create_response = $docraptor.create_async_doc(
   test:             true,
@@ -28,7 +29,6 @@ output_payload = $docraptor.get_async_doc(status_response.download_id)
 
 File.write(output_file, output_payload)
 output_type = `file -b #{output_file}`
-File.delete output_file
 
 raise "Output was not a PDF" unless output_type.start_with?("PDF")
 

data/test/expire_hosted.rb

@@ -2,19 +2,15 @@ require "bundler/setup"
 Bundler.require
 require 'open-uri'
 
-api_key = File.read("#{__dir__}/../.docraptor_key").strip
-unless api_key
-  raise "Please put a valid (paid plan) api key in the .docraptor_key file when testing this feature."
-end
-
 DocRaptor.configure do |dr|
-  dr.username  = api_key
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 
 $docraptor = DocRaptor::DocApi.new
 
-output_file = "expire-hosted-ruby-sync.pdf"
+test_output_dir = File.join(File.dirname(File.expand_path(__FILE__)), "..", "tmp", "test_output")
+output_file = File.join(test_output_dir, "#{File.basename(__FILE__, ".rb")}_ruby_#{RUBY_VERSION}.pdf")
 
 output_payload = $docraptor.create_hosted_async_doc(
   test:             true,
@@ -31,18 +27,17 @@ status_response = nil
   sleep 1
 end
 
-actual_document = open status_response.download_url
+actual_document = URI.parse(status_response.download_url).open
 IO.copy_stream(actual_document, output_file)
 
 output_type = `file -b #{output_file}`
-File.delete output_file
 
 raise "Output was not a PDF" unless output_type.start_with?("PDF")
 
 $docraptor.expire(status_response.download_id)
 
 begin
-  actual_document = open status_response.download_url
+  actual_document = URI.parse(status_response.download_url).open
 rescue OpenURI::HTTPError => http_error
   exit 0
 end

data/test/hosted_async.rb

@@ -2,19 +2,15 @@ require "bundler/setup"
 Bundler.require
 require "open-uri"
 
-api_key = File.read("#{__dir__}/../.docraptor_key").strip
-unless api_key
-  raise "Please put a valid (paid plan) api key in the .docraptor_key file when testing this feature."
-end
-
 DocRaptor.configure do |dr|
-  dr.username  = api_key
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 
 $docraptor = DocRaptor::DocApi.new
 
-output_file = "hosted-ruby-sync.pdf"
+test_output_dir = File.join(File.dirname(File.expand_path(__FILE__)), "..", "tmp", "test_output")
+output_file = File.join(test_output_dir, "#{File.basename(__FILE__, ".rb")}_ruby_#{RUBY_VERSION}.pdf")
 
 output_payload = $docraptor.create_hosted_async_doc(
   test:             true,
@@ -31,4 +27,9 @@ status_response = nil
   sleep 1
 end
 
+output_payload = $docraptor.get_async_doc(status_response.download_id)
+
+File.write(output_file, output_payload)
+output_type = `file -b #{output_file}`
 
+raise "Output was not a PDF" unless output_type.start_with?("PDF")

data/test/hosted_sync.rb

@@ -2,19 +2,15 @@ require "bundler/setup"
 Bundler.require
 require "open-uri"
 
-api_key = File.read("#{__dir__}/../.docraptor_key").strip
-unless api_key
-  raise "Please put a valid (paid plan) api key in the .docraptor_key file when testing this feature."
-end
-
 DocRaptor.configure do |dr|
-  dr.username  = api_key
+  dr.username  = "YOUR_API_KEY_HERE"
   # dr.debugging = true
 end
 
 $docraptor = DocRaptor::DocApi.new
 
-output_file = "hosted-ruby-sync.pdf"
+test_output_dir = File.join(File.dirname(File.expand_path(__FILE__)), "..", "tmp", "test_output")
+output_file = File.join(test_output_dir, "#{File.basename(__FILE__, ".rb")}_ruby_#{RUBY_VERSION}.pdf")
 
 output_payload = $docraptor.create_hosted_doc(
   test:             true,
@@ -24,10 +20,9 @@ output_payload = $docraptor.create_hosted_doc(
   hosted_expires_at: (Time.now + 86400).strftime('%FT%T%:z'), # 1 day from now
 )
 
-actual_document = open output_payload.download_url
+actual_document = URI.parse(output_payload.download_url).open
 IO.copy_stream(actual_document, output_file)
 
 output_type = `file -b #{output_file}`
-File.delete output_file
 
 raise "Output was not a PDF" unless output_type.start_with?("PDF")

data/test/sync.rb

@@ -8,7 +8,8 @@ end
 
 $docraptor = DocRaptor::DocApi.new
 
-output_file = "ruby-sync.pdf"
+test_output_dir = File.join(File.dirname(File.expand_path(__FILE__)), "..", "tmp", "test_output")
+output_file = File.join(test_output_dir, "#{File.basename(__FILE__, ".rb")}_ruby_#{RUBY_VERSION}.pdf")
 
 output_payload = $docraptor.create_doc(
   test:             true,
@@ -19,6 +20,5 @@ output_payload = $docraptor.create_doc(
 
 File.write(output_file, output_payload)
 output_type = `file -b #{output_file}`
-File.delete output_file
 
 raise "Output was not a PDF" unless output_type.start_with?("PDF")

data/test/xlsx.rb

@@ -8,7 +8,8 @@ end
 
 $docraptor = DocRaptor::DocApi.new
 
-output_file = "ruby-xlsx.xlsx"
+test_output_dir = File.join(File.dirname(File.expand_path(__FILE__)), "..", "tmp", "test_output")
+output_file = File.join(test_output_dir, "#{File.basename(__FILE__, ".rb")}_ruby_#{RUBY_VERSION}.xlsx")
 
 output_payload = $docraptor.create_doc(
   test:             true,
@@ -19,6 +20,8 @@ output_payload = $docraptor.create_doc(
 
 File.write(output_file, output_payload)
 output_type = `file -b #{output_file}`
-File.delete output_file
 
-raise "Output was not an XLSX (zip)" unless output_type.start_with?("Zip")
+# Older version of `file` only recognize it as a zip file
+if !output_type.start_with?("Microsoft OOXML") && !output_type.start_with?("Zip")
+  raise "Output was not an XLSX: #{output_type.inspect}"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docraptor
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Expected Behavior
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -30,206 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "~>"
-      - !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.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.1
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.24'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.24.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.24.3
-- !ruby/object:Gem::Dependency
-  name: autotest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.4.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.4.6
-- !ruby/object:Gem::Dependency
-  name: autotest-rails-pure
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.2
-- !ruby/object:Gem::Dependency
-  name: autotest-growl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.16
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.16
-- !ruby/object:Gem::Dependency
-  name: autotest-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.12
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.12
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.2.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.2.2
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 3.6.0
 description: A native client library for the DocRaptor HTML to PDF/XLS service.
 email:
 - support@docraptor.com
@@ -237,11 +57,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".docker_env.list"
+- ".generator-language-identifier"
+- ".generator-revision"
+- ".github/pull_request_template.txt"
 - ".gitignore"
+- ".gitlab-ci.yml"
+- ".openapi-generator-ignore"
+- ".openapi-generator/FILES"
+- ".openapi-generator/VERSION"
+- ".review/README.md"
+- ".review/generated_files/.gitignore"
+- ".review/generated_files/README.md"
 - ".rspec"
-- ".swagger-codegen-ignore"
-- ".swagger-codegen/VERSION"
-- ".swagger-revision"
+- ".rubocop.yml"
+- ".runtime-environments"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -253,6 +84,11 @@ files:
 - examples/hosted_async.rb
 - examples/hosted_sync.rb
 - examples/sync.rb
+- gemfiles/Gemfile.2.5.lock
+- gemfiles/Gemfile.2.6.lock
+- gemfiles/Gemfile.2.7.lock
+- gemfiles/Gemfile.3.0.lock
+- generator-config.json
 - lib/docraptor.rb
 - lib/docraptor/api/doc_api.rb
 - lib/docraptor/api_client.rb
@@ -264,16 +100,17 @@ files:
 - lib/docraptor/models/prince_options.rb
 - lib/docraptor/version.rb
 - script/clean
+- script/console
+- script/docker
 - script/fix_gemspec.rb
 - script/generate_language
+- script/inside_container/README.md
+- script/inside_container/test
 - script/post_generate_language
+- script/setup
 - script/swagger
 - script/test
 - script/update_from_upstream
-- spec/api_client_spec.rb
-- spec/configuration_spec.rb
-- spec/spec_helper.rb
-- swagger-config.json
 - test/async.rb
 - test/expire_hosted.rb
 - test/hosted_async.rb
@@ -286,7 +123,7 @@ homepage: https://github.com/docraptor/docraptor-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -294,21 +131,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: A wrapper for the DocRaptor HTML to PDF/XLS service.
 test_files:
-- spec/api_client_spec.rb
-- spec/configuration_spec.rb
-- spec/spec_helper.rb
 - test/async.rb
 - test/expire_hosted.rb
 - test/hosted_async.rb

data/.swagger-codegen/VERSION

@@ -1 +0,0 @@
-2.4.14

data/.swagger-revision

@@ -1 +0,0 @@
-v2.4.14