docraptor 1.1.0 → 2.0.0

data/lib/docraptor/models/doc.rb

@@ -1,10 +1,19 @@
+=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
   class Doc
-    # Specify a specific verison of the DocRaptor Pipeline to use.
-    attr_accessor :pipeline
-
     # A name for identifying your document.
     attr_accessor :name
 
@@ -20,12 +29,18 @@ module DocRaptor
     # Enable test mode for this document. Test documents are not charged for but include a watermark.
     attr_accessor :test
 
+    # Specify a specific verison of the DocRaptor Pipeline to use.
+    attr_accessor :pipeline
+
     # Force strict HTML validation.
     attr_accessor :strict
 
     # Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.
     attr_accessor :ignore_resource_errors
 
+    # Prevent console.log from stopping document rendering during JavaScript execution.
+    attr_accessor :ignore_console_messages
+
     # A field for storing a small amount of metadata with this document.
     attr_accessor :tag
 
@@ -38,210 +53,284 @@ module DocRaptor
     # Set HTTP referrer when generating this document.
     attr_accessor :referrer
 
-    # A URL that will receive a POST request after successfully completing an asynchronous document. The POST data will include download_url and download_id similar to status api responses. WARNING: this only works on asynchronous documents.
+    # A URL that will receive a POST request after successfully completing an asynchronous document. The POST data will include download_url and download_id similar to status API responses. WARNING: this only works on asynchronous documents.
     attr_accessor :callback_url
 
+    # The number of times a hosted document can be downloaded.  If no limit is specified, the document will be available for an unlimited number of downloads.
+    attr_accessor :hosted_download_limit
+
+    # The date and time at which a hosted document will be removed and no longer available. Must be a properly formatted ISO 8601 datetime, like 1981-01-23T08:02:30-05:00.
+    attr_accessor :hosted_expires_at
+
     attr_accessor :prince_options
 
+    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
       {
-
-        :'pipeline' => :'pipeline',
-
         :'name' => :'name',
-
         :'document_type' => :'document_type',
-
         :'document_content' => :'document_content',
-
         :'document_url' => :'document_url',
-
         :'test' => :'test',
-
+        :'pipeline' => :'pipeline',
         :'strict' => :'strict',
-
         :'ignore_resource_errors' => :'ignore_resource_errors',
-
+        :'ignore_console_messages' => :'ignore_console_messages',
         :'tag' => :'tag',
-
         :'help' => :'help',
-
         :'javascript' => :'javascript',
-
         :'referrer' => :'referrer',
-
         :'callback_url' => :'callback_url',
-
+        :'hosted_download_limit' => :'hosted_download_limit',
+        :'hosted_expires_at' => :'hosted_expires_at',
         :'prince_options' => :'prince_options'
-
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'pipeline' => :'String',
         :'name' => :'String',
         :'document_type' => :'String',
         :'document_content' => :'String',
         :'document_url' => :'String',
         :'test' => :'BOOLEAN',
+        :'pipeline' => :'String',
         :'strict' => :'String',
         :'ignore_resource_errors' => :'BOOLEAN',
+        :'ignore_console_messages' => :'BOOLEAN',
         :'tag' => :'String',
         :'help' => :'BOOLEAN',
         :'javascript' => :'BOOLEAN',
         :'referrer' => :'String',
         :'callback_url' => :'String',
+        :'hosted_download_limit' => :'Integer',
+        :'hosted_expires_at' => :'String',
         :'prince_options' => :'PrinceOptions'
-
       }
     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}
-
-
-      if attributes[:'pipeline']
-        self.pipeline = attributes[:'pipeline']
-      end
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes[:'name']
+      if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes[:'document_type']
+      if attributes.has_key?(:'document_type')
         self.document_type = attributes[:'document_type']
       end
 
-      if attributes[:'document_content']
+      if attributes.has_key?(:'document_content')
         self.document_content = attributes[:'document_content']
       end
 
-      if attributes[:'document_url']
+      if attributes.has_key?(:'document_url')
         self.document_url = attributes[:'document_url']
       end
 
-      if attributes[:'test']
+      if attributes.has_key?(:'test')
         self.test = attributes[:'test']
       else
         self.test = true
       end
 
-      if attributes[:'strict']
+      if attributes.has_key?(:'pipeline')
+        self.pipeline = attributes[:'pipeline']
+      end
+
+      if attributes.has_key?(:'strict')
         self.strict = attributes[:'strict']
-      else
-        self.strict = "none"
       end
 
-      if attributes[:'ignore_resource_errors']
+      if attributes.has_key?(:'ignore_resource_errors')
         self.ignore_resource_errors = attributes[:'ignore_resource_errors']
       else
         self.ignore_resource_errors = true
       end
 
-      if attributes[:'tag']
+      if attributes.has_key?(:'ignore_console_messages')
+        self.ignore_console_messages = attributes[:'ignore_console_messages']
+      else
+        self.ignore_console_messages = false
+      end
+
+      if attributes.has_key?(:'tag')
         self.tag = attributes[:'tag']
       end
 
-      if attributes[:'help']
+      if attributes.has_key?(:'help')
         self.help = attributes[:'help']
       else
         self.help = false
       end
 
-      if attributes[:'javascript']
+      if attributes.has_key?(:'javascript')
         self.javascript = attributes[:'javascript']
       else
         self.javascript = false
       end
 
-      if attributes[:'referrer']
+      if attributes.has_key?(:'referrer')
         self.referrer = attributes[:'referrer']
       end
 
-      if attributes[:'callback_url']
+      if attributes.has_key?(:'callback_url')
         self.callback_url = attributes[:'callback_url']
       end
 
-      if attributes[:'prince_options']
+      if attributes.has_key?(:'hosted_download_limit')
+        self.hosted_download_limit = attributes[:'hosted_download_limit']
+      end
+
+      if attributes.has_key?(:'hosted_expires_at')
+        self.hosted_expires_at = attributes[:'hosted_expires_at']
+      end
+
+      if attributes.has_key?(:'prince_options')
         self.prince_options = attributes[:'prince_options']
       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
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @document_type.nil?
+        invalid_properties.push('invalid value for "document_type", document_type cannot be nil.')
+      end
+
+      if @document_content.nil?
+        invalid_properties.push('invalid value for "document_content", document_content cannot be nil.')
+      end
+
+      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?
+      return false if @name.nil?
+      return false if @document_type.nil?
+      document_type_validator = EnumAttributeValidator.new('String', ['pdf', 'xls', 'xlsx'])
+      return false unless document_type_validator.valid?(@document_type)
+      return false if @document_content.nil?
+      strict_validator = EnumAttributeValidator.new('String', ['none', 'html'])
+      return false unless strict_validator.valid?(@strict)
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] document_type Object to be assigned
     def document_type=(document_type)
-      allowed_values = ["pdf", "xls", "xlsx"]
-      if document_type && !allowed_values.include?(document_type)
-        fail "invalid value for 'document_type', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ['pdf', 'xls', 'xlsx'])
+      unless validator.valid?(document_type)
+        fail ArgumentError, 'invalid value for "document_type", must be one of #{validator.allowable_values}.'
       end
       @document_type = document_type
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] strict Object to be assigned
     def strict=(strict)
-      allowed_values = ["none"]
-      if strict && !allowed_values.include?(strict)
-        fail "invalid value for 'strict', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ['none', 'html'])
+      unless validator.valid?(strict)
+        fail ArgumentError, 'invalid value for "strict", must be one of #{validator.allowable_values}.'
       end
       @strict = strict
     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 &&
-          pipeline == o.pipeline &&
           name == o.name &&
           document_type == o.document_type &&
           document_content == o.document_content &&
           document_url == o.document_url &&
           test == o.test &&
+          pipeline == o.pipeline &&
           strict == o.strict &&
           ignore_resource_errors == o.ignore_resource_errors &&
+          ignore_console_messages == o.ignore_console_messages &&
           tag == o.tag &&
           help == o.help &&
           javascript == o.javascript &&
           referrer == o.referrer &&
           callback_url == o.callback_url &&
+          hosted_download_limit == o.hosted_download_limit &&
+          hosted_expires_at == o.hosted_expires_at &&
           prince_options == o.prince_options
     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
-      [pipeline, name, document_type, document_content, document_url, test, strict, ignore_resource_errors, tag, help, javascript, referrer, callback_url, prince_options].hash
+      [name, document_type, document_content, document_url, test, pipeline, strict, ignore_resource_errors, ignore_console_messages, tag, help, javascript, referrer, callback_url, hosted_download_limit, hosted_expires_at, prince_options].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
@@ -255,7 +344,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
@@ -266,7 +355,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|
@@ -275,21 +364,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|
@@ -300,11 +393,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/models/{async_doc_status.rb → doc_status.rb}

@@ -1,14 +1,26 @@
+=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
-  class AsyncDocStatus
+  class DocStatus
     # The present status of the document. Can be queued, working, completed, and failed.
     attr_accessor :status
 
     # The URL where the document can be retrieved. This URL may only be used a few times.
     attr_accessor :download_url
 
-    # The identifier for downloading the document with the download api.
+    # The identifier for downloading the document with the download API.
     attr_accessor :download_id
 
     # Additional information.
@@ -23,19 +35,12 @@ module DocRaptor
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-
         :'status' => :'status',
-
         :'download_url' => :'download_url',
-
         :'download_id' => :'download_id',
-
         :'message' => :'message',
-
         :'number_of_pages' => :'number_of_pages',
-
         :'validation_errors' => :'validation_errors'
-
       }
     end
 
@@ -48,44 +53,57 @@ module DocRaptor
         :'message' => :'String',
         :'number_of_pages' => :'Integer',
         :'validation_errors' => :'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[:'status']
+      if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
 
-      if attributes[:'download_url']
+      if attributes.has_key?(:'download_url')
         self.download_url = attributes[:'download_url']
       end
 
-      if attributes[:'download_id']
+      if attributes.has_key?(:'download_id')
         self.download_id = attributes[:'download_id']
       end
 
-      if attributes[:'message']
+      if attributes.has_key?(:'message')
         self.message = attributes[:'message']
       end
 
-      if attributes[:'number_of_pages']
+      if attributes.has_key?(:'number_of_pages')
         self.number_of_pages = attributes[:'number_of_pages']
       end
 
-      if attributes[:'validation_errors']
+      if attributes.has_key?(:'validation_errors')
         self.validation_errors = attributes[:'validation_errors']
       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 equality by comparing each attribute.
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -98,35 +116,41 @@ module DocRaptor
     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
       [status, download_url, download_id, message, number_of_pages, validation_errors].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
@@ -140,7 +164,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
@@ -151,7 +175,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|
@@ -160,21 +184,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|
@@ -185,11 +213,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) }