docraptor 3.0.0 → 3.1.0

data/script/docker

@@ -1,5 +1,6 @@
 #!/bin/bash
 set -e
+[[ "$TRACE" == "true" ]] && set -x
 cd "$(dirname "$0")/.."
 
 OPTIND=1
@@ -24,16 +25,32 @@ if [[ "$image" == "" ]]; then
   echo "docker image (-i) unset, defaulting to: $image"
 fi
 
+if ! docker pull "$image"; then
+  echo "Pulling the latest version of ${image} failed, but we'll continue in"
+  echo "the hopes that there's a previous version of the container available."
+  echo "This probably isn't an issue unless you really want to verify"
+  echo "everything works with a :latest container image."
+fi
+
 command="$1"
 
-cache_dir="$(pwd)/tmp/cache_${image}"
-mkdir -p "$cache_dir"
+mounts=()
+while IFS=':' read -r source target; do
+  # Create the directory if it's not a special/magic path (like for ssh)
+  mkdir -p -m 700 "$source" &> /dev/null || true
+
+  mounts+=(--volume)
+  mounts+=("${source}:${target}")
+
+  # Can't pipe to the while loop because that causes a subshell, which means
+  # the variables set in the loop aren't available outside of it.
+done < <(eval echo "\"$(grep -v '^#' .docker_mounts.list)\"")
 
 set -x
-docker run --pull=always -it --rm \
+docker run -it --rm \
   --env-file .docker_env.list \
   --env RUNTIME_ENV="${image}" \
   --mount type=bind,source="$(pwd)",target=/app \
-  --mount type=bind,source="${cache_dir}",target=/app/tmp/cache \
+  "${mounts[@]}" \
   "$image" \
   "$command"

data/script/generate_language

@@ -1,5 +1,6 @@
 #!/bin/bash
 set -e
+[[ "$TRACE" == "true" ]] && set -x
 cd "$(dirname "$0")/.."
 
 LANGUAGE="$(cat .generator-language-identifier)"
@@ -22,10 +23,18 @@ fi
 echo "Facilitating generated content review"
 tmp_dir=".review/tmp"
 review_root=".review/generated_files"
+# Clear the tmp_dir, where we'll temporarily store our files so they aren't
+# overwritten by the generated files.
 rm -rf "$tmp_dir"
 (cd "$review_root" && find . -type f) | while read file_path; do
-  mkdir -p "$(dirname "${tmp_dir}/$file_path")"
-  mv -v "$file_path" "${tmp_dir}/$file_path"
+  # Move our file out of the way so it doesn't get overwritten by the generated
+  # file, but only if the file exists. Some files, like the generated docs and
+  # tests, aren't useful to users to we generally remove them, but we still
+  # want to facilitate review of these generated files.
+  if [ -e "$file_path" ]; then
+    mkdir -p "$(dirname "${tmp_dir}/$file_path")"
+    mv -v "$file_path" "${tmp_dir}/$file_path"
+  fi
 done
 
 ./script/swagger generate \
@@ -41,6 +50,19 @@ fi
 # See .review/README.md
 echo "Facilitating generated content review"
 (cd "$review_root" && find . -type f) | while read file_path; do
-  mv -v "$file_path" "$review_root/$file_path"
-  mv -v "${tmp_dir}/$file_path" "$file_path"
+  # Update $review_root to match the generated files.
+  if [ -e "$file_path" ]; then
+    # Move the newly generated file into the review directory so we'll be able to
+    # see it in the diff.
+    mv -v "$file_path" "$review_root/$file_path"
+  else
+    # If the file doesn't exist, then it was removed by the generator, so we
+    # should remove it from the review directory as well.
+    rm -v "$review_root/$file_path"
+  fi
+  # If we temporarily stored a file (meaning it existed before the generation)
+  # then move it back into place.
+  if [ -e "${tmp_dir}/$file_path" ]; then
+    mv -v "${tmp_dir}/$file_path" "$file_path"
+  fi
 done

data/script/inside_container/test

@@ -2,6 +2,9 @@
 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)
 
@@ -24,15 +27,61 @@ 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() {
-  ruby $1 && echo "PASS $1" || (echo "FAIL $1"; exit 1)
+  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
+    run_test $test || success="false"
   done
 else
-  run_test $1.rb
+  run_test $1.rb || success="false"
+fi
+
+if [ $success == "true" ]; then
+  exit 0
+else
+  exit 1
 fi

data/script/post_generate_language

@@ -1,10 +1,8 @@
 #!/bin/bash
 set -e
+[[ "$TRACE" == "true" ]] && set -x
 cd "$(dirname "$0")/.."
 
-echo "Removing unnecessary generated specs..."
-rm -r spec
-
 echo "Removing trailing whitespace..."
 find lib -name "*.rb" -type f -exec sed -E -i '' 's/[[:space:]]+$//g' {} +
 

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/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/xlsx.rb

@@ -21,7 +21,11 @@ output_payload = $docraptor.create_doc(
 File.write(output_file, output_payload)
 output_type = `file -b #{output_file}`
 
-# Older version of `file` only recognize it as a zip file
-if !output_type.start_with?("Microsoft OOXML") && !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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docraptor
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Expected Behavior
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -58,6 +58,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".docker_env.list"
+- ".docker_mounts.list"
 - ".generator-language-identifier"
 - ".generator-revision"
 - ".github/pull_request_template.txt"
@@ -69,6 +70,19 @@ files:
 - ".review/README.md"
 - ".review/generated_files/.gitignore"
 - ".review/generated_files/README.md"
+- ".review/generated_files/docs/AsyncDoc.md"
+- ".review/generated_files/docs/Doc.md"
+- ".review/generated_files/docs/DocApi.md"
+- ".review/generated_files/docs/DocStatus.md"
+- ".review/generated_files/docs/PrinceOptions.md"
+- ".review/generated_files/spec/api/doc_api_spec.rb"
+- ".review/generated_files/spec/api_client_spec.rb"
+- ".review/generated_files/spec/configuration_spec.rb"
+- ".review/generated_files/spec/models/async_doc_spec.rb"
+- ".review/generated_files/spec/models/doc_spec.rb"
+- ".review/generated_files/spec/models/doc_status_spec.rb"
+- ".review/generated_files/spec/models/prince_options_spec.rb"
+- ".review/generated_files/spec/spec_helper.rb"
 - ".rspec"
 - ".rubocop.yml"
 - ".runtime-environments"
@@ -88,6 +102,9 @@ files:
 - gemfiles/Gemfile.2.6.lock
 - gemfiles/Gemfile.2.7.lock
 - gemfiles/Gemfile.3.0.lock
+- gemfiles/Gemfile.3.1.lock
+- gemfiles/Gemfile.3.2.lock
+- gemfiles/Gemfile.3.3.lock
 - generator-config.json
 - lib/docraptor.rb
 - lib/docraptor/api/doc_api.rb
@@ -107,6 +124,7 @@ files:
 - script/inside_container/README.md
 - script/inside_container/test
 - script/post_generate_language
+- script/release
 - script/setup
 - script/swagger
 - script/test
@@ -115,15 +133,19 @@ files:
 - test/expire_hosted.rb
 - test/hosted_async.rb
 - test/hosted_sync.rb
+- test/iframes_default.rb
+- test/iframes_false.rb
+- test/iframes_true.rb
 - test/invalid_async.rb
 - test/invalid_sync.rb
+- test/prince_options.rb
 - test/sync.rb
 - test/xlsx.rb
 homepage: https://github.com/docraptor/docraptor-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.5.0.dev
+signing_key:
 specification_version: 4
 summary: A wrapper for the DocRaptor HTML to PDF/XLS service.
 test_files:
@@ -147,7 +169,11 @@ test_files:
 - test/expire_hosted.rb
 - test/hosted_async.rb
 - test/hosted_sync.rb
+- test/iframes_default.rb
+- test/iframes_false.rb
+- test/iframes_true.rb
 - test/invalid_async.rb
 - test/invalid_sync.rb
+- test/prince_options.rb
 - test/sync.rb
 - test/xlsx.rb