docraptor 2.0.0 → 3.1.0

data/script/inside_container/test

@@ -0,0 +1,87 @@
+#!/bin/bash
+set -e
+cd "$(dirname "$0")/../.."
+
+apt update
+apt install poppler-utils -y
+
+# check dependencies
+ruby -v > /dev/null    || (echo "ruby must be installed"; exit 1)
+
+major_minor_version="$(ruby -e 'puts RUBY_VERSION.split(".")[0, 2].join(".")')"
+gemfile_lock="gemfiles/Gemfile.${major_minor_version}.lock"
+if [ -f "$gemfile_lock" ]; then
+  cp -v "$gemfile_lock" Gemfile.lock
+else
+  rm -vf Gemfile.lock
+fi
+
+bundle -v > /dev/null  || (echo "bundler must be installed"; exit 1)
+
+# TODO: update to test against updates dependencies as well
+bundle install
+
+if [ ! -f "$gemfile_lock" ]; then
+  cp -v Gemfile.lock "$gemfile_lock"
+fi
+
+cd test
+
+
+green() {
+  tput bold    # bold text
+  tput setaf 2 # green text
+  echo -n "$@"
+  tput sgr0    # reset to default text
+}
+red() {
+  tput bold    # bold text
+  tput setaf 1 # red text
+  echo -n "$@"
+  tput sgr0    # reset to default text
+}
+
+
+key_relative_path="tmp/.docraptor_key"
+key_path="../$key_relative_path"
+
+# runs a test file with PASS/FAIL message
+run_test() {
+  test_success="true"
+  test_name="$1 ${2:-(without $key_relative_path)}"
+  if [[ "$DOCRAPTOR_KEY" == "" ]] && [ -f "$key_path" ]; then
+    (
+      export DOCRAPTOR_KEY="$(cat "$key_path")"
+      run_test $1 "(with $key_relative_path)"
+    ) || test_success="false"
+  fi
+
+  if ruby $1; then
+    echo "$(green PASS) $test_name"
+  else
+    test_success="false"
+    echo "$(red FAIL) $test_name"
+  fi
+
+  if [ $test_success == "true" ]; then
+    return 0
+  else
+    return 1
+  fi
+}
+
+success="true"
+
+if [ "$1" == "" ]; then
+  for test in $(ls *.rb); do
+    run_test $test || success="false"
+  done
+else
+  run_test $1.rb || success="false"
+fi
+
+if [ $success == "true" ]; then
+  exit 0
+else
+  exit 1
+fi

data/script/post_generate_language

@@ -1,9 +1,15 @@
-#!/bin/sh
+#!/bin/bash
 set -e
-cd "`dirname \"$0\"`/.."
+[[ "$TRACE" == "true" ]] && set -x
+cd "$(dirname "$0")/.."
 
 echo "Removing trailing whitespace..."
 find lib -name "*.rb" -type f -exec sed -E -i '' 's/[[:space:]]+$//g' {} +
 
 echo "Fixing gemspec to work around swagger..."
 ruby script/fix_gemspec.rb
+
+if compgen -G "patches/*.patch" > /dev/null; then
+  echo "Apply patches to generated code"
+  git apply --verbose patches/*.patch
+fi

data/script/release

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -e
+[[ "$TRACE" == "true" ]] && set -x
+cd "$(dirname "$0")/.."
+
+
+if [[ "$INSIDE_DOCKER" != "true" ]]; then
+  git config --local user.email "$(git config --get user.email)"
+  exec script/docker "/app/script/$(basename "$0")"
+fi
+
+public_remote="$(git remote -v | grep -i 'git@github.com:DocRaptor/docraptor-ruby.git' | head -n 1 | cut -f1)"
+rake "release[${public_remote}]"

data/script/setup

@@ -2,24 +2,35 @@
 set -e
 cd "$(dirname "$0")/.."
 
-rbenv which ruby || (brew upgrade ruby-build || true; rbenv install)
+setup_echo() {
+  echo "[script/setup] $1"
+}
 
-# Setup rbenv so we can switch rubies below
-eval "$(rbenv init - --no-rehash)"
+setup_error() {
+  echo "[script/setup][ERROR] $1"
+}
 
-for ruby_version in `ruby -ryaml -e 'puts YAML.load(File.read(".travis.yml"))["rvm"].join(" ")'`; do
-  rbenv versions --bare | grep "^${ruby_version}$" || rbenv install $ruby_version
-  rbenv shell $ruby_version
-  gem list -i bundler --version 2.2.15 >/dev/null || gem install bundler:2.2.15
+brew_install() {
+  setup_echo "Installing $1..."
+  brew list --formula "$1" > /dev/null || brew install --formula "$1"
+}
 
-  bundle install
-done
+brew_cask_install() {
+  setup_echo "Installing cask $1..."
+  brew list --cask "$1" &> /dev/null || brew install --cask "$1"
+}
+
+brew_cask_install docker
+brew_install docker
+
+# Avoid a warning message (vs. --overwrite)
+brew unlink docker && brew link docker
 
 tput bold    # bold text
 tput setaf 2 # green text
-echo "****************************************************************"
-echo "*                                                              *"
-echo "*                         Good to go!                          *"
-echo "*                                                              *"
-echo "****************************************************************"
+setup_echo "****************************************************************"
+setup_echo "*                                                              *"
+setup_echo "*                         Good to go!                          *"
+setup_echo "*                                                              *"
+setup_echo "****************************************************************"
 tput sgr0    # reset to default text

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,46 +1,49 @@
-#!/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
-
-# runs a test file with PASS/FAIL message
-run_test() {
-  ruby $1 && echo "PASS $1" || (echo "FAIL $1"; exit 1)
-}
+[ -f script/build ] && script/build
 
 run_tests() {
-  if [ "$1" == "" ]; then
-    for test in $(ls *.rb); do
-      run_test $test
-    done
+  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
-    run_test $1.rb
+    tput bold    # bold text
+    tput setaf 1 # red text
+    echo "======================================"
+    echo "$runtime_env FAILED"
+    echo "======================================"
+    tput sgr0    # reset to default text
+    return 1
   fi
 }
 
 success="true"
 
-# Setup rbenv so we can switch rubies below
-eval "$(rbenv init - --no-rehash)"
-
-for ruby_version in `ruby -ryaml -e 'puts YAML.load(File.read(".travis.yml"))["rvm"].join(" ")'`; do
-  {
-    echo "testing ruby version $ruby_version" &&
-      rbenv shell $ruby_version &&
-      ( cd test && run_tests )
-  } || success="false"
+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 "=              Passed                ="
+  echo "=      Full Test Suite Passed        ="
   echo "======================================"
   tput sgr0    # reset to default text
   exit 0
@@ -48,7 +51,7 @@ else
   tput bold    # bold text
   tput setaf 1 # red text
   echo "======================================"
-  echo "=              FAILED                ="
+  echo "=      Full Test Suite FAILED        ="
   echo "======================================"
   tput sgr0    # reset to default text
   exit 1

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

@@ -9,7 +9,8 @@ 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,
@@ -30,7 +31,6 @@ 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")
 

data/test/hosted_async.rb

@@ -9,7 +9,8 @@ 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,
@@ -26,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

@@ -9,7 +9,8 @@ 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,
@@ -23,6 +24,5 @@ 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/iframes_default.rb

@@ -0,0 +1,40 @@
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username  = ENV["DOCRAPTOR_KEY"] || "YOUR_API_KEY_HERE"
+  # dr.debugging = true
+end
+
+# TODO: Remove once pipeline 10 is public. At that point the try it out user
+# will be able to use the iframes option, so this test will pass.
+unless ENV["DOCRAPTOR_KEY"]
+  puts "Skipping #{$0} because DOCRAPTOR_KEY is not set."
+  exit(0)
+end
+
+$docraptor = DocRaptor::DocApi.new
+
+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,
+  document_content: <<~HTML,
+    <html><body>
+      <p>Baseline text</p>
+      <iframe src="https://docraptor-test-harness.herokuapp.com/public/index.html"></iframe>
+    </body></html>
+  HTML
+  name:             output_file,
+  document_type:    "pdf",
+  pipeline:         "10",
+  # prince_options:   { iframes: true },
+)
+
+File.write(output_file, output_payload)
+output_type = `file -b #{output_file}`
+
+raise "Output was not a PDF" unless output_type.start_with?("PDF")
+
+text = `pdftotext #{output_file} -`
+raise "Output shouldn't load iframe" if text !~ /Test/

data/test/iframes_false.rb

@@ -0,0 +1,40 @@
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username  = ENV["DOCRAPTOR_KEY"] || "YOUR_API_KEY_HERE"
+  # dr.debugging = true
+end
+
+# TODO: Remove once pipeline 10 is public. At that point the try it out user
+# will be able to use the iframes option, so this test will pass.
+unless ENV["DOCRAPTOR_KEY"]
+  puts "Skipping #{$0} because DOCRAPTOR_KEY is not set."
+  exit(0)
+end
+
+$docraptor = DocRaptor::DocApi.new
+
+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,
+  document_content: <<~HTML,
+    <html><body>
+      <p>Baseline text</p>
+      <iframe src="https://docraptor-test-harness.herokuapp.com/public/index.html"></iframe>
+    </body></html>
+  HTML
+  name:             output_file,
+  document_type:    "pdf",
+  pipeline:         "10",
+  prince_options:   { iframes: false },
+)
+
+File.write(output_file, output_payload)
+output_type = `file -b #{output_file}`
+
+raise "Output was not a PDF" unless output_type.start_with?("PDF")
+
+text = `pdftotext #{output_file} -`
+raise "Output shouldn't load iframe" if text =~ /Test/

data/test/iframes_true.rb

@@ -0,0 +1,40 @@
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username  = ENV["DOCRAPTOR_KEY"] || "YOUR_API_KEY_HERE"
+  # dr.debugging = true
+end
+
+# TODO: Remove once pipeline 10 is public. At that point the try it out user
+# will be able to use the iframes option, so this test will pass.
+unless ENV["DOCRAPTOR_KEY"]
+  puts "Skipping #{$0} because DOCRAPTOR_KEY is not set."
+  exit(0)
+end
+
+$docraptor = DocRaptor::DocApi.new
+
+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,
+  document_content: <<~HTML,
+    <html><body>
+      <p>Baseline text</p>
+      <iframe src="https://docraptor-test-harness.herokuapp.com/public/index.html"></iframe>
+    </body></html>
+  HTML
+  name:             output_file,
+  document_type:    "pdf",
+  pipeline:         "10",
+  prince_options:   { iframes: true },
+)
+
+File.write(output_file, output_payload)
+output_type = `file -b #{output_file}`
+
+raise "Output was not a PDF" unless output_type.start_with?("PDF")
+
+text = `pdftotext #{output_file} -`
+raise "Output shouldn't load iframe" if text !~ /Test/

data/test/prince_options.rb

@@ -0,0 +1,45 @@
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username  = "YOUR_API_KEY_HERE"
+  # dr.debugging = true
+end
+
+$docraptor = DocRaptor::DocApi.new
+
+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")
+
+# Verify the test works as expected by confirming that this url will fail
+# without prince_options[insecure]=true.
+begin
+  $docraptor.create_doc(
+    test:             true,
+    document_url: "https://expired.badssl.com/",
+    name:             output_file,
+    document_type:    "pdf",
+  )
+rescue DocRaptor::ApiError => ex
+  expected_message = "SSL Error downloading document content from supplied url.";
+  if ex.message !~ /#{expected_message}/
+    raise "Wrong exception, expected: #{expected_message}, got: #{ex.message}"
+  end
+end
+
+# Verify prince_options works by testing a url that will fail without
+# prince_options[insecure]=true.
+output_payload = $docraptor.create_doc(
+  test:             true,
+  document_url: "https://expired.badssl.com/",
+  name:             output_file,
+  document_type:    "pdf",
+  prince_options: {
+    insecure: true,
+  }
+)
+
+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/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,12 @@ 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")
+acceptable_output_types = [
+  "Microsoft Excel 2007+",                      # Newest versions of `file`
+  "Microsoft OOXML",                            # Older versions of `file`
+  "Zip archive data, at least v2.0 to extract", # Even older versions of `file`
+]
+if !acceptable_output_types.include?(output_type.strip)
+  raise "Output was not an XLSX: #{output_type.inspect}"
+end