docraptor 0.0.1 → 0.0.2

data/lib/docraptor/models/prince_options.rb

@@ -1,96 +1,150 @@
+require 'date'
+
 module DocRaptor
-  # 
-  class PrinceOptions < BaseObject
-    attr_accessor :baseurl, :no_xinclude, :no_network, :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, :input, :version, :javascript, :css_dpi, :profile
-    # attribute mapping from ruby-style variable name to JSON key
+  class PrinceOptions
+    # Set the baseurl for assets.
+    attr_accessor :baseurl
+
+    # Disable XML inclusion.
+    attr_accessor :no_xinclude
+
+    # Disable network access.
+    attr_accessor :no_network
+
+    # Set the user for HTTP authentication.
+    attr_accessor :http_user
+
+    # Set the password for HTTP authentication.
+    attr_accessor :http_password
+
+    # Set the HTTP proxy server.
+    attr_accessor :http_proxy
+
+    # Set the HTTP request timeout.
+    attr_accessor :http_timeout
+
+    # Disable SSL verification.
+    attr_accessor :insecure
+
+    # Specify the CSS media type. Defaults to \"print\" but you may want to use \"screen\" for web styles.
+    attr_accessor :media
+
+    # Ignore author stylesheets.
+    attr_accessor :no_author_style
+
+    # Ignore default stylesheets.
+    attr_accessor :no_default_style
+
+    # Disable font embedding in PDFs.
+    attr_accessor :no_embed_fonts
+
+    # Disable font subsetting in PDFs.
+    attr_accessor :no_subset_fonts
+
+    # Disable PDF compression.
+    attr_accessor :no_compress
+
+    # Encrypt PDF output.
+    attr_accessor :encrypt
+
+    # Set encryption key size.
+    attr_accessor :key_bits
+
+    # Set the PDF user password.
+    attr_accessor :user_password
+
+    # Set the PDF owner password.
+    attr_accessor :owner_password
+
+    # Disallow printing of this PDF.
+    attr_accessor :disallow_print
+
+    # Disallow copying of this PDF.
+    attr_accessor :disallow_copy
+
+    # Disallow annotation of this PDF.
+    attr_accessor :disallow_annotate
+
+    # Disallow modification of this PDF.
+    attr_accessor :disallow_modify
+
+    # Specify the input format.
+    attr_accessor :input
+
+    # Specify a specific verison of PrinceXML to use.
+    attr_accessor :version
+
+    # Enable PrinceXML JavaScript. DocRaptor JavaScript parsing is also available elsewhere.
+    attr_accessor :javascript
+
+    # Set the DPI when rendering CSS. Defaults to 96 but can be set with Prince 9.0 and up.
+    attr_accessor :css_dpi
+
+    # In Prince 9.0 and up you can set the PDF profile.
+    attr_accessor :profile
+
+    # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        # Set the baseurl for assets.
         :'baseurl' => :'baseurl',
         
-        # Disable XML inclusion.
         :'no_xinclude' => :'no_xinclude',
         
-        # Disable network access.
         :'no_network' => :'no_network',
         
-        # Set the user for HTTP authentication.
         :'http_user' => :'http_user',
         
-        # Set the password for HTTP authentication.
         :'http_password' => :'http_password',
         
-        # Set the HTTP proxy server.
         :'http_proxy' => :'http_proxy',
         
-        # Set the HTTP request timeout.
         :'http_timeout' => :'http_timeout',
         
-        # Disable SSL verification.
         :'insecure' => :'insecure',
         
-        # Specify the CSS media type. Defaults to \&quot;print\&quot; but you may want to use \&quot;screen\&quot; for web styles.
         :'media' => :'media',
         
-        # Ignore author stylesheets.
         :'no_author_style' => :'no_author_style',
         
-        # Ignore default stylesheets.
         :'no_default_style' => :'no_default_style',
         
-        # Disable font embedding in PDFs.
         :'no_embed_fonts' => :'no_embed_fonts',
         
-        # Disable font subsetting in PDFs.
         :'no_subset_fonts' => :'no_subset_fonts',
         
-        # Disable PDF compression.
         :'no_compress' => :'no_compress',
         
-        # Encrypt PDF output.
         :'encrypt' => :'encrypt',
         
-        # Set encryption key size.
         :'key_bits' => :'key_bits',
         
-        # Set the PDF user password.
         :'user_password' => :'user_password',
         
-        # Set the PDF owner password.
         :'owner_password' => :'owner_password',
         
-        # Disallow printing of this PDF.
         :'disallow_print' => :'disallow_print',
         
-        # Disallow copying of this PDF.
         :'disallow_copy' => :'disallow_copy',
         
-        # Disallow annotation of this PDF.
         :'disallow_annotate' => :'disallow_annotate',
         
-        # Disallow modification of this PDF.
         :'disallow_modify' => :'disallow_modify',
         
-        # Specify the input format.
         :'input' => :'input',
         
-        # Specify a specific verison of PrinceXML to use.
         :'version' => :'version',
         
-        # Enable PrinceXML JavaScript. DocRaptor JavaScript parsing is also available elsewhere.
         :'javascript' => :'javascript',
         
-        # Set the DPI when rendering CSS. Defaults to 96 but can be set with Prince 9.0 and up.
         :'css_dpi' => :'css_dpi',
         
-        # In Prince 9.0 and up you can set the PDF profile.
         :'profile' => :'profile'
         
       }
     end
 
-    # attribute type
+    # Attribute type mapping.
     def self.swagger_types
       {
         :'baseurl' => :'String',
@@ -125,7 +179,7 @@ module DocRaptor
     end
 
     def initialize(attributes = {})
-      return if !attributes.is_a?(Hash) || attributes.empty?
+      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}
@@ -165,6 +219,8 @@ module DocRaptor
       
       if attributes[:'media']
         self.media = attributes[:'media']
+      else
+        self.media = "print"
       end
       
       if attributes[:'no_author_style']
@@ -221,6 +277,8 @@ module DocRaptor
       
       if attributes[:'input']
         self.input = attributes[:'input']
+      else
+        self.input = "html"
       end
       
       if attributes[:'version']
@@ -241,6 +299,7 @@ module DocRaptor
       
     end
 
+    # Custom attribute writer method checking allowed values (enum).
     def input=(input)
       allowed_values = ["html", "xml", "auto"]
       if input && !allowed_values.include?(input)
@@ -249,5 +308,139 @@ module DocRaptor
       @input = input
     end
 
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          baseurl == o.baseurl &&
+          no_xinclude == o.no_xinclude &&
+          no_network == o.no_network &&
+          http_user == o.http_user &&
+          http_password == o.http_password &&
+          http_proxy == o.http_proxy &&
+          http_timeout == o.http_timeout &&
+          insecure == o.insecure &&
+          media == o.media &&
+          no_author_style == o.no_author_style &&
+          no_default_style == o.no_default_style &&
+          no_embed_fonts == o.no_embed_fonts &&
+          no_subset_fonts == o.no_subset_fonts &&
+          no_compress == o.no_compress &&
+          encrypt == o.encrypt &&
+          key_bits == o.key_bits &&
+          user_password == o.user_password &&
+          owner_password == o.owner_password &&
+          disallow_print == o.disallow_print &&
+          disallow_copy == o.disallow_copy &&
+          disallow_annotate == o.disallow_annotate &&
+          disallow_modify == o.disallow_modify &&
+          input == o.input &&
+          version == o.version &&
+          javascript == o.javascript &&
+          css_dpi == o.css_dpi &&
+          profile == o.profile
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [baseurl, no_xinclude, no_network, 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, input, version, javascript, css_dpi, profile].hash
+    end
+
+    # build the object from hash
+    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 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
+          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
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      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/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = DocRaptor.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
   end
 end

data/lib/docraptor/version.rb

@@ -1,3 +1,3 @@
 module DocRaptor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docraptor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Elijah Miller
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -228,7 +228,6 @@ files:
 - lib/docraptor/configuration.rb
 - lib/docraptor/models/async_doc.rb
 - lib/docraptor/models/async_doc_status.rb
-- lib/docraptor/models/base_object.rb
 - lib/docraptor/models/doc.rb
 - lib/docraptor/models/prince_options.rb
 - lib/docraptor/version.rb
@@ -252,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A wrapper for the DocRaptor HTML to PDF/XLS service.

data/lib/docraptor/models/base_object.rb

@@ -1,86 +0,0 @@
-require 'date'
-
-module DocRaptor
-  # base class containing fundamental method such as to_hash, build_from_hash and more
-  class BaseObject
-
-    # build the object from hash
-    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 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
-          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
-
-      self
-    end
-
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :BOOLEAN
-        if value =~ /^(true|t|yes|y|1)$/i
-          true
-        else
-          false
-        end
-      else # model
-        _model = DocRaptor.const_get(type).new
-        _model.build_from_hash(value)
-      end
-    end
-
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_body (backward compatibility))
-    def to_body
-      to_hash
-    end
-
-    # return the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        next if value.nil?
-        if value.is_a?(Array)
-          hash[param] = value.compact.map{ |v| _to_hash(v) }
-        else
-          hash[param] = _to_hash(value)
-        end
-      end
-      hash
-    end
-
-    # Method to output non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    def _to_hash(value)
-      if value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-  end
-end