docraptor 1.1.0 → 2.0.0

data/lib/docraptor/models/prince_options.rb

@@ -1,3 +1,15 @@
+=begin
+#DocRaptor
+
+#A native client library for the DocRaptor HTML to PDF/XLS service.
+
+OpenAPI spec version: 1.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
 require 'date'
 
 module DocRaptor
@@ -77,7 +89,7 @@ module DocRaptor
     # Specify the input format.
     attr_accessor :input
 
-    # Specify a specific verison of PrinceXML to use.
+    # Deprecated, use the appropriate `pipeline` version. Specify a specific verison of PrinceXML to use.
     attr_accessor :version
 
     # Enable PrinceXML JavaScript. DocRaptor JavaScript parsing is also available elsewhere.
@@ -89,68 +101,64 @@ module DocRaptor
     # In Prince 9.0 and up you can set the PDF profile.
     attr_accessor :profile
 
+    # Specify the PDF title, part of the document's metadata.
+    attr_accessor :pdf_title
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-
         :'baseurl' => :'baseurl',
-
         :'no_xinclude' => :'no_xinclude',
-
         :'no_network' => :'no_network',
-
         :'no_parallel_downloads' => :'no_parallel_downloads',
-
         :'http_user' => :'http_user',
-
         :'http_password' => :'http_password',
-
         :'http_proxy' => :'http_proxy',
-
         :'http_timeout' => :'http_timeout',
-
         :'insecure' => :'insecure',
-
         :'media' => :'media',
-
         :'no_author_style' => :'no_author_style',
-
         :'no_default_style' => :'no_default_style',
-
         :'no_embed_fonts' => :'no_embed_fonts',
-
         :'no_subset_fonts' => :'no_subset_fonts',
-
         :'no_compress' => :'no_compress',
-
         :'encrypt' => :'encrypt',
-
         :'key_bits' => :'key_bits',
-
         :'user_password' => :'user_password',
-
         :'owner_password' => :'owner_password',
-
         :'disallow_print' => :'disallow_print',
-
         :'disallow_copy' => :'disallow_copy',
-
         :'disallow_annotate' => :'disallow_annotate',
-
         :'disallow_modify' => :'disallow_modify',
-
         :'debug' => :'debug',
-
         :'input' => :'input',
-
         :'version' => :'version',
-
         :'javascript' => :'javascript',
-
         :'css_dpi' => :'css_dpi',
-
-        :'profile' => :'profile'
-
+        :'profile' => :'profile',
+        :'pdf_title' => :'pdf_title'
       }
     end
 
@@ -185,150 +193,171 @@ module DocRaptor
         :'version' => :'String',
         :'javascript' => :'BOOLEAN',
         :'css_dpi' => :'Integer',
-        :'profile' => :'String'
-
+        :'profile' => :'String',
+        :'pdf_title' => :'String'
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-
-      if attributes[:'baseurl']
+      if attributes.has_key?(:'baseurl')
         self.baseurl = attributes[:'baseurl']
       end
 
-      if attributes[:'no_xinclude']
+      if attributes.has_key?(:'no_xinclude')
         self.no_xinclude = attributes[:'no_xinclude']
       end
 
-      if attributes[:'no_network']
+      if attributes.has_key?(:'no_network')
         self.no_network = attributes[:'no_network']
       end
 
-      if attributes[:'no_parallel_downloads']
+      if attributes.has_key?(:'no_parallel_downloads')
         self.no_parallel_downloads = attributes[:'no_parallel_downloads']
       end
 
-      if attributes[:'http_user']
+      if attributes.has_key?(:'http_user')
         self.http_user = attributes[:'http_user']
       end
 
-      if attributes[:'http_password']
+      if attributes.has_key?(:'http_password')
         self.http_password = attributes[:'http_password']
       end
 
-      if attributes[:'http_proxy']
+      if attributes.has_key?(:'http_proxy')
         self.http_proxy = attributes[:'http_proxy']
       end
 
-      if attributes[:'http_timeout']
+      if attributes.has_key?(:'http_timeout')
         self.http_timeout = attributes[:'http_timeout']
       end
 
-      if attributes[:'insecure']
+      if attributes.has_key?(:'insecure')
         self.insecure = attributes[:'insecure']
       end
 
-      if attributes[:'media']
+      if attributes.has_key?(:'media')
         self.media = attributes[:'media']
       else
-        self.media = "print"
+        self.media = 'print'
       end
 
-      if attributes[:'no_author_style']
+      if attributes.has_key?(:'no_author_style')
         self.no_author_style = attributes[:'no_author_style']
       end
 
-      if attributes[:'no_default_style']
+      if attributes.has_key?(:'no_default_style')
         self.no_default_style = attributes[:'no_default_style']
       end
 
-      if attributes[:'no_embed_fonts']
+      if attributes.has_key?(:'no_embed_fonts')
         self.no_embed_fonts = attributes[:'no_embed_fonts']
       end
 
-      if attributes[:'no_subset_fonts']
+      if attributes.has_key?(:'no_subset_fonts')
         self.no_subset_fonts = attributes[:'no_subset_fonts']
       end
 
-      if attributes[:'no_compress']
+      if attributes.has_key?(:'no_compress')
         self.no_compress = attributes[:'no_compress']
       end
 
-      if attributes[:'encrypt']
+      if attributes.has_key?(:'encrypt')
         self.encrypt = attributes[:'encrypt']
       end
 
-      if attributes[:'key_bits']
+      if attributes.has_key?(:'key_bits')
         self.key_bits = attributes[:'key_bits']
       end
 
-      if attributes[:'user_password']
+      if attributes.has_key?(:'user_password')
         self.user_password = attributes[:'user_password']
       end
 
-      if attributes[:'owner_password']
+      if attributes.has_key?(:'owner_password')
         self.owner_password = attributes[:'owner_password']
       end
 
-      if attributes[:'disallow_print']
+      if attributes.has_key?(:'disallow_print')
         self.disallow_print = attributes[:'disallow_print']
       end
 
-      if attributes[:'disallow_copy']
+      if attributes.has_key?(:'disallow_copy')
         self.disallow_copy = attributes[:'disallow_copy']
       end
 
-      if attributes[:'disallow_annotate']
+      if attributes.has_key?(:'disallow_annotate')
         self.disallow_annotate = attributes[:'disallow_annotate']
       end
 
-      if attributes[:'disallow_modify']
+      if attributes.has_key?(:'disallow_modify')
         self.disallow_modify = attributes[:'disallow_modify']
       end
 
-      if attributes[:'debug']
+      if attributes.has_key?(:'debug')
         self.debug = attributes[:'debug']
       end
 
-      if attributes[:'input']
+      if attributes.has_key?(:'input')
         self.input = attributes[:'input']
       else
-        self.input = "html"
+        self.input = 'html'
       end
 
-      if attributes[:'version']
+      if attributes.has_key?(:'version')
         self.version = attributes[:'version']
       end
 
-      if attributes[:'javascript']
+      if attributes.has_key?(:'javascript')
         self.javascript = attributes[:'javascript']
       end
 
-      if attributes[:'css_dpi']
+      if attributes.has_key?(:'css_dpi')
         self.css_dpi = attributes[:'css_dpi']
       end
 
-      if attributes[:'profile']
+      if attributes.has_key?(:'profile')
         self.profile = attributes[:'profile']
       end
 
+      if attributes.has_key?(:'pdf_title')
+        self.pdf_title = attributes[:'pdf_title']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # 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'])
+      return false unless input_validator.valid?(@input)
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] input Object to be assigned
     def input=(input)
-      allowed_values = ["html", "xml", "auto"]
-      if input && !allowed_values.include?(input)
-        fail "invalid value for 'input', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ['html', 'xml', 'auto'])
+      unless validator.valid?(input)
+        fail ArgumentError, 'invalid value for "input", must be one of #{validator.allowable_values}.'
       end
       @input = input
     end
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -360,39 +389,46 @@ module DocRaptor
           version == o.version &&
           javascript == o.javascript &&
           css_dpi == o.css_dpi &&
-          profile == o.profile
+          profile == o.profile &&
+          pdf_title == o.pdf_title
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] 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].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
     end
 
-    # build the object from hash
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @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 =~ /^Array<(.*)>/i
+        if 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)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          else
-            #TODO show warning in debug mode
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
 
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
@@ -406,7 +442,7 @@ module DocRaptor
       when :Float
         value.to_f
       when :BOOLEAN
-        if value.to_s =~ /^(true|t|yes|y|1)$/i
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
           false
@@ -417,7 +453,7 @@ module DocRaptor
       when /\AArray<(?<inner_type>.+)>\z/
         inner_type = Regexp.last_match[:inner_type]
         value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
         k_type = Regexp.last_match[:k_type]
         v_type = Regexp.last_match[:v_type]
         {}.tap do |hash|
@@ -426,21 +462,25 @@ module DocRaptor
           end
         end
       else # model
-        _model = DocRaptor.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = DocRaptor.const_get(type).new
+        temp_model.build_from_hash(value)
       end
     end
 
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
     def to_s
       to_hash.to_s
     end
 
-    # to_body is an alias to to_body (backward compatibility))
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
     def to_body
       to_hash
     end
 
-    # return the object in the form of hash
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
     def to_hash
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
@@ -451,11 +491,13 @@ module DocRaptor
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }

data/lib/docraptor/version.rb

@@ -1,3 +1,15 @@
+=begin
+#DocRaptor
+
+#A native client library for the DocRaptor HTML to PDF/XLS service.
+
+OpenAPI spec version: 1.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
 module DocRaptor
-  VERSION = "1.1.0"
+  VERSION = '2.0.0'
 end