docraptor 2.0.0 → 3.1.0

data/lib/docraptor/models/prince_options.rb

@@ -3,14 +3,15 @@
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.4.0
+The version of the OpenAPI document: 2.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
 =end
 
 require 'date'
+require 'time'
 
 module DocRaptor
   class PrinceOptions
@@ -86,7 +87,7 @@ module DocRaptor
     # Enable Prince debug mode.
     attr_accessor :debug
 
-    # Specify the input format.
+    # Specify the input format, defaults to html.
     attr_accessor :input
 
     # Deprecated, use the appropriate `pipeline` version. Specify a specific verison of PrinceXML to use.
@@ -104,6 +105,15 @@ module DocRaptor
     # Specify the PDF title, part of the document's metadata.
     attr_accessor :pdf_title
 
+    # Enable loading of iframes.
+    attr_accessor :iframes
+
+    # Specify the page margin distance.
+    attr_accessor :page_margin
+
+    # Make form fields editable by default.
+    attr_accessor :pdf_forms
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -158,177 +168,210 @@ module DocRaptor
         :'javascript' => :'javascript',
         :'css_dpi' => :'css_dpi',
         :'profile' => :'profile',
-        :'pdf_title' => :'pdf_title'
+        :'pdf_title' => :'pdf_title',
+        :'iframes' => :'iframes',
+        :'page_margin' => :'page_margin',
+        :'pdf_forms' => :'pdf_forms'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'baseurl' => :'String',
-        :'no_xinclude' => :'BOOLEAN',
-        :'no_network' => :'BOOLEAN',
-        :'no_parallel_downloads' => :'BOOLEAN',
+        :'no_xinclude' => :'Boolean',
+        :'no_network' => :'Boolean',
+        :'no_parallel_downloads' => :'Boolean',
         :'http_user' => :'String',
         :'http_password' => :'String',
         :'http_proxy' => :'String',
         :'http_timeout' => :'Integer',
-        :'insecure' => :'BOOLEAN',
+        :'insecure' => :'Boolean',
         :'media' => :'String',
-        :'no_author_style' => :'BOOLEAN',
-        :'no_default_style' => :'BOOLEAN',
-        :'no_embed_fonts' => :'BOOLEAN',
-        :'no_subset_fonts' => :'BOOLEAN',
-        :'no_compress' => :'BOOLEAN',
-        :'encrypt' => :'BOOLEAN',
+        :'no_author_style' => :'Boolean',
+        :'no_default_style' => :'Boolean',
+        :'no_embed_fonts' => :'Boolean',
+        :'no_subset_fonts' => :'Boolean',
+        :'no_compress' => :'Boolean',
+        :'encrypt' => :'Boolean',
         :'key_bits' => :'Integer',
         :'user_password' => :'String',
         :'owner_password' => :'String',
-        :'disallow_print' => :'BOOLEAN',
-        :'disallow_copy' => :'BOOLEAN',
-        :'disallow_annotate' => :'BOOLEAN',
-        :'disallow_modify' => :'BOOLEAN',
-        :'debug' => :'BOOLEAN',
+        :'disallow_print' => :'Boolean',
+        :'disallow_copy' => :'Boolean',
+        :'disallow_annotate' => :'Boolean',
+        :'disallow_modify' => :'Boolean',
+        :'debug' => :'Boolean',
         :'input' => :'String',
         :'version' => :'String',
-        :'javascript' => :'BOOLEAN',
+        :'javascript' => :'Boolean',
         :'css_dpi' => :'Integer',
         :'profile' => :'String',
-        :'pdf_title' => :'String'
+        :'pdf_title' => :'String',
+        :'iframes' => :'Boolean',
+        :'page_margin' => :'String',
+        :'pdf_forms' => :'Boolean'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'iframes',
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocRaptor::PrinceOptions` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocRaptor::PrinceOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'baseurl')
+      if attributes.key?(:'baseurl')
         self.baseurl = attributes[:'baseurl']
       end
 
-      if attributes.has_key?(:'no_xinclude')
+      if attributes.key?(:'no_xinclude')
         self.no_xinclude = attributes[:'no_xinclude']
       end
 
-      if attributes.has_key?(:'no_network')
+      if attributes.key?(:'no_network')
         self.no_network = attributes[:'no_network']
       end
 
-      if attributes.has_key?(:'no_parallel_downloads')
+      if attributes.key?(:'no_parallel_downloads')
         self.no_parallel_downloads = attributes[:'no_parallel_downloads']
       end
 
-      if attributes.has_key?(:'http_user')
+      if attributes.key?(:'http_user')
         self.http_user = attributes[:'http_user']
       end
 
-      if attributes.has_key?(:'http_password')
+      if attributes.key?(:'http_password')
         self.http_password = attributes[:'http_password']
       end
 
-      if attributes.has_key?(:'http_proxy')
+      if attributes.key?(:'http_proxy')
         self.http_proxy = attributes[:'http_proxy']
       end
 
-      if attributes.has_key?(:'http_timeout')
+      if attributes.key?(:'http_timeout')
         self.http_timeout = attributes[:'http_timeout']
       end
 
-      if attributes.has_key?(:'insecure')
+      if attributes.key?(:'insecure')
         self.insecure = attributes[:'insecure']
       end
 
-      if attributes.has_key?(:'media')
+      if attributes.key?(:'media')
         self.media = attributes[:'media']
-      else
-        self.media = 'print'
       end
 
-      if attributes.has_key?(:'no_author_style')
+      if attributes.key?(:'no_author_style')
         self.no_author_style = attributes[:'no_author_style']
       end
 
-      if attributes.has_key?(:'no_default_style')
+      if attributes.key?(:'no_default_style')
         self.no_default_style = attributes[:'no_default_style']
       end
 
-      if attributes.has_key?(:'no_embed_fonts')
+      if attributes.key?(:'no_embed_fonts')
         self.no_embed_fonts = attributes[:'no_embed_fonts']
       end
 
-      if attributes.has_key?(:'no_subset_fonts')
+      if attributes.key?(:'no_subset_fonts')
         self.no_subset_fonts = attributes[:'no_subset_fonts']
       end
 
-      if attributes.has_key?(:'no_compress')
+      if attributes.key?(:'no_compress')
         self.no_compress = attributes[:'no_compress']
       end
 
-      if attributes.has_key?(:'encrypt')
+      if attributes.key?(:'encrypt')
         self.encrypt = attributes[:'encrypt']
       end
 
-      if attributes.has_key?(:'key_bits')
+      if attributes.key?(:'key_bits')
         self.key_bits = attributes[:'key_bits']
       end
 
-      if attributes.has_key?(:'user_password')
+      if attributes.key?(:'user_password')
         self.user_password = attributes[:'user_password']
       end
 
-      if attributes.has_key?(:'owner_password')
+      if attributes.key?(:'owner_password')
         self.owner_password = attributes[:'owner_password']
       end
 
-      if attributes.has_key?(:'disallow_print')
+      if attributes.key?(:'disallow_print')
         self.disallow_print = attributes[:'disallow_print']
       end
 
-      if attributes.has_key?(:'disallow_copy')
+      if attributes.key?(:'disallow_copy')
         self.disallow_copy = attributes[:'disallow_copy']
       end
 
-      if attributes.has_key?(:'disallow_annotate')
+      if attributes.key?(:'disallow_annotate')
         self.disallow_annotate = attributes[:'disallow_annotate']
       end
 
-      if attributes.has_key?(:'disallow_modify')
+      if attributes.key?(:'disallow_modify')
         self.disallow_modify = attributes[:'disallow_modify']
       end
 
-      if attributes.has_key?(:'debug')
+      if attributes.key?(:'debug')
         self.debug = attributes[:'debug']
       end
 
-      if attributes.has_key?(:'input')
+      if attributes.key?(:'input')
         self.input = attributes[:'input']
-      else
-        self.input = 'html'
       end
 
-      if attributes.has_key?(:'version')
+      if attributes.key?(:'version')
         self.version = attributes[:'version']
       end
 
-      if attributes.has_key?(:'javascript')
+      if attributes.key?(:'javascript')
         self.javascript = attributes[:'javascript']
       end
 
-      if attributes.has_key?(:'css_dpi')
+      if attributes.key?(:'css_dpi')
         self.css_dpi = attributes[:'css_dpi']
       end
 
-      if attributes.has_key?(:'profile')
+      if attributes.key?(:'profile')
         self.profile = attributes[:'profile']
       end
 
-      if attributes.has_key?(:'pdf_title')
+      if attributes.key?(:'pdf_title')
         self.pdf_title = attributes[:'pdf_title']
       end
+
+      if attributes.key?(:'iframes')
+        self.iframes = attributes[:'iframes']
+      end
+
+      if attributes.key?(:'page_margin')
+        self.page_margin = attributes[:'page_margin']
+      end
+
+      if attributes.key?(:'pdf_forms')
+        self.pdf_forms = attributes[:'pdf_forms']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -341,17 +384,29 @@ module DocRaptor
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      input_validator = EnumAttributeValidator.new('String', ['html', 'xml', 'auto'])
+      key_bits_validator = EnumAttributeValidator.new('Integer', [40, 128])
+      return false unless key_bits_validator.valid?(@key_bits)
+      input_validator = EnumAttributeValidator.new('String', ["html", "xml", "auto"])
       return false unless input_validator.valid?(@input)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] key_bits Object to be assigned
+    def key_bits=(key_bits)
+      validator = EnumAttributeValidator.new('Integer', [40, 128])
+      unless validator.valid?(key_bits)
+        fail ArgumentError, "invalid value for \"key_bits\", must be one of #{validator.allowable_values}."
+      end
+      @key_bits = key_bits
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] input Object to be assigned
     def input=(input)
-      validator = EnumAttributeValidator.new('String', ['html', 'xml', 'auto'])
+      validator = EnumAttributeValidator.new('String', ["html", "xml", "auto"])
       unless validator.valid?(input)
-        fail ArgumentError, 'invalid value for "input", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"input\", must be one of #{validator.allowable_values}."
       end
       @input = input
     end
@@ -390,7 +445,10 @@ module DocRaptor
           javascript == o.javascript &&
           css_dpi == o.css_dpi &&
           profile == o.profile &&
-          pdf_title == o.pdf_title
+          pdf_title == o.pdf_title &&
+          iframes == o.iframes &&
+          page_margin == o.page_margin &&
+          pdf_forms == o.pdf_forms
     end
 
     # @see the `==` method
@@ -400,9 +458,16 @@ module DocRaptor
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [baseurl, no_xinclude, no_network, no_parallel_downloads, http_user, http_password, http_proxy, http_timeout, insecure, media, no_author_style, no_default_style, no_embed_fonts, no_subset_fonts, no_compress, encrypt, key_bits, user_password, owner_password, disallow_print, disallow_copy, disallow_annotate, disallow_modify, debug, input, version, javascript, css_dpi, profile, pdf_title].hash
+      [baseurl, no_xinclude, no_network, no_parallel_downloads, http_user, http_password, http_proxy, http_timeout, insecure, media, no_author_style, no_default_style, no_embed_fonts, no_subset_fonts, no_compress, encrypt, key_bits, user_password, owner_password, disallow_print, disallow_copy, disallow_annotate, disallow_modify, debug, input, version, javascript, css_dpi, profile, pdf_title, iframes, page_margin, pdf_forms].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
     end
 
     # Builds the object from hash
@@ -410,8 +475,11 @@ module DocRaptor
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
@@ -419,7 +487,7 @@ module DocRaptor
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        end
       end
 
       self
@@ -431,8 +499,8 @@ module DocRaptor
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -441,7 +509,7 @@ module DocRaptor
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -462,8 +530,9 @@ module DocRaptor
           end
         end
       else # model
-        temp_model = DocRaptor.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = DocRaptor.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -485,7 +554,11 @@ module DocRaptor
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -510,4 +583,5 @@ module DocRaptor
     end
 
   end
+
 end

data/lib/docraptor/version.rb

@@ -3,13 +3,13 @@
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.4.0
+The version of the OpenAPI document: 2.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
 =end
 
 module DocRaptor
-  VERSION = '2.0.0'
+  VERSION = '3.1.0'
 end

data/lib/docraptor.rb

@@ -3,10 +3,10 @@
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.4.0
+The version of the OpenAPI document: 2.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
 =end
 

data/script/clean

@@ -1,5 +1,5 @@
-#!/bin/sh
+#!/bin/bash
 set -e
-cd "`dirname \"$0\"`/.."
+cd "$(dirname "$0")/.."
 
 rm -rf lib/

data/script/console

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+cd "$(dirname "$0")/.."
+
+script/docker "$@" /bin/bash

data/script/docker

@@ -0,0 +1,56 @@
+#!/bin/bash
+set -e
+[[ "$TRACE" == "true" ]] && set -x
+cd "$(dirname "$0")/.."
+
+OPTIND=1
+
+image=""
+
+while getopts "h?i:" opt; do
+  case "$opt" in
+    h|\?)
+      show_help
+      exit 0
+      ;;
+    i)  image="$OPTARG"
+      ;;
+  esac
+done
+
+shift $((OPTIND-1))
+
+if [[ "$image" == "" ]]; then
+  image="$(cat .runtime-environments | grep -v '^#' | tail -n 1)"
+  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"
+
+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 -it --rm \
+  --env-file .docker_env.list \
+  --env RUNTIME_ENV="${image}" \
+  --mount type=bind,source="$(pwd)",target=/app \
+  "${mounts[@]}" \
+  "$image" \
+  "$command"

data/script/fix_gemspec.rb

@@ -1,28 +1,16 @@
-# coding: utf-8
+# These, at least the first two, significantly increase speed of a test run by
+# limiting the filesystem interaction that occurs with bundler installing and
+# requiring files.
 bad_files         = %q{s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }}
 good_files        = %q{s.files         = `git ls-files`.split("\n").uniq.sort.select { |f| !f.empty? }}
 bad_test_files    = %q{s.test_files    = `find spec/*`.split("\n")}
 good_test_files   = %q{s.test_files    = `git ls-files spec test`.split("\n")}
-bad_ruby_version  = %q{s.required_ruby_version = ">= 1.9"}
-good_ruby_version = %q{s.required_ruby_version = ">= 2.3"}
-
-development_dependency_marker = %q{  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'}
-development_dependency_marker_plus_injection =
-"  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
-
-  # added by script/fix_gemspec.rb.
-  s.add_development_dependency 'rake', '~>11.2', '>= 11.2.2'
-  s.add_development_dependency 'pry', '~>0.10', '>= 0.10.4'
-  # </added> : if the above lines are missing in the gemspec, then
-  # the matcher for autotest is probably broken"
 
 filename = "docraptor.gemspec"
 content = File.read(filename)
 [
   bad_files,
   bad_test_files,
-  bad_ruby_version,
-  development_dependency_marker
 ].each do |bad_content_to_check|
   unless content.include?(bad_content_to_check)
     raise "Couldn't find content in docraptor.gemspec. Check matchers in there for: “#{bad_content_to_check}”"
@@ -31,9 +19,6 @@ end
 updated_content = content.dup
 updated_content.sub!(bad_files, good_files)
 updated_content.sub!(bad_test_files, good_test_files)
-updated_content.sub!(bad_ruby_version, good_ruby_version)
-updated_content.sub!(development_dependency_marker,
-                     development_dependency_marker_plus_injection)
 
 File.open(filename, "w") do |file|
   file.write(updated_content)

data/script/generate_language

@@ -1,9 +1,10 @@
-#!/bin/sh
+#!/bin/bash
 set -e
+[[ "$TRACE" == "true" ]] && set -x
 cd "$(dirname "$0")/.."
 
-LANGUAGE="$1"
-CONFIG_FILE="swagger-config.json"
+LANGUAGE="$(cat .generator-language-identifier)"
+CONFIG_FILE="generator-config.json"
 
 if [ "$LANGUAGE" = "" ]; then
   ./script/swagger # prints languages
@@ -18,12 +19,50 @@ fi
 
 ./script/clean
 
+# See .review/README.md
+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
+  # 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 \
   -i docraptor.yaml \
-  -l "$LANGUAGE" \
+  -g "$LANGUAGE" \
   -c "$CONFIG_FILE"
 
 # call a generator cleanup script
 if [ -f "script/post_generate_language" ]; then
   ./script/post_generate_language
 fi
+
+# See .review/README.md
+echo "Facilitating generated content review"
+(cd "$review_root" && find . -type f) | while read file_path; do
+  # 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/README.md

@@ -0,0 +1,6 @@
+This folder contains scripts that are only intended to be run inside
+of a relevant docker container. For example, `script/test` may run
+`script/inside_container/test` inside a container with particular
+versions of libraries to make it easy to test the agent in multiple
+settings. It's possible these scripts will work outside of any
+particular container, but that may or may not mean anything.