Class: DocRaptor::Doc

Inherits:
Object
  • Object
show all
Defined in:
lib/docraptor/models/doc.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Doc

Returns a new instance of Doc.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/docraptor/models/doc.rb', line 96

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[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'document_type']
    self.document_type = attributes[:'document_type']
  end
  
  if attributes[:'document_content']
    self.document_content = attributes[:'document_content']
  end
  
  if attributes[:'document_url']
    self.document_url = attributes[:'document_url']
  end
  
  if attributes[:'test']
    self.test = attributes[:'test']
  else
    self.test = true
  end
  
  if attributes[:'strict']
    self.strict = attributes[:'strict']
  else
    self.strict = "none"
  end
  
  if attributes[:'ignore_resource_errors']
    self.ignore_resource_errors = attributes[:'ignore_resource_errors']
  else
    self.ignore_resource_errors = true
  end
  
  if attributes[:'tag']
    self.tag = attributes[:'tag']
  end
  
  if attributes[:'help']
    self.help = attributes[:'help']
  else
    self.help = false
  end
  
  if attributes[:'javascript']
    self.javascript = attributes[:'javascript']
  else
    self.javascript = false
  end
  
  if attributes[:'referrer']
    self.referrer = attributes[:'referrer']
  end
  
  if attributes[:'callback_url']
    self.callback_url = attributes[:'callback_url']
  end
  
  if attributes[:'prince_options']
    self.prince_options = attributes[:'prince_options']
  end
  
end

Instance Attribute Details

#callback_url ⇒ Object

A URL that will receive a POST request after successfully completing an asynchronous document.nThe POST data will include download_url and download_id similar to status api responses.nWARNING: this only works on asynchronous documents.



39
40
41
 
# File 'lib/docraptor/models/doc.rb', line 39

def callback_url
  @callback_url
end

#document_content ⇒ Object

The HTML data to be transformed into a document.nYou must supply content using document_content or document_url.



12
13
14
 
# File 'lib/docraptor/models/doc.rb', line 12

def document_content
  @document_content
end

#document_type ⇒ Object

The type of document being created.



9
10
11
 
# File 'lib/docraptor/models/doc.rb', line 9

def document_type
  @document_type
end

#document_url ⇒ Object

The URL to fetch the HTML data to be transformed into a document.nYou must supply content using document_content or document_url.



15
16
17
 
# File 'lib/docraptor/models/doc.rb', line 15

def document_url
  @document_url
end

#help ⇒ Object

Request support help with this request if it succeeds.



30
31
32
 
# File 'lib/docraptor/models/doc.rb', line 30

def help
  @help
end

#ignore_resource_errors ⇒ Object

Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.



24
25
26
 
# File 'lib/docraptor/models/doc.rb', line 24

def ignore_resource_errors
  @ignore_resource_errors
end

#javascript ⇒ Object

Enable DocRaptor JavaScript parsing. PrinceXML JavaScript parsing is also available elsewhere.



33
34
35
 
# File 'lib/docraptor/models/doc.rb', line 33

def javascript
  @javascript
end

#name ⇒ Object

A name for identifying your document.



6
7
8
 
# File 'lib/docraptor/models/doc.rb', line 6

def name
  @name
end

#prince_options ⇒ Object

Returns the value of attribute prince_options.



41
42
43
 
# File 'lib/docraptor/models/doc.rb', line 41

def prince_options
  @prince_options
end

#referrer ⇒ Object

Set HTTP referrer when generating this document.



36
37
38
 
# File 'lib/docraptor/models/doc.rb', line 36

def referrer
  @referrer
end

#strict ⇒ Object

Force strict HTML validation.



21
22
23
 
# File 'lib/docraptor/models/doc.rb', line 21

def strict
  @strict
end

#tag ⇒ Object

A field for storing a small amount of metadata with this document.



27
28
29
 
# File 'lib/docraptor/models/doc.rb', line 27

def tag
  @tag
end

#test ⇒ Object

Enable test mode for this document. Test documents are not charged for but include a watermark.



18
19
20
 
# File 'lib/docraptor/models/doc.rb', line 18

def test
  @test
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/docraptor/models/doc.rb', line 44

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'document_type' => :'document_type',
    
    :'document_content' => :'document_content',
    
    :'document_url' => :'document_url',
    
    :'test' => :'test',
    
    :'strict' => :'strict',
    
    :'ignore_resource_errors' => :'ignore_resource_errors',
    
    :'tag' => :'tag',
    
    :'help' => :'help',
    
    :'javascript' => :'javascript',
    
    :'referrer' => :'referrer',
    
    :'callback_url' => :'callback_url',
    
    :'prince_options' => :'prince_options'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/docraptor/models/doc.rb', line 77

def self.swagger_types
  {
    :'name' => :'String',
    :'document_type' => :'String',
    :'document_content' => :'String',
    :'document_url' => :'String',
    :'test' => :'BOOLEAN',
    :'strict' => :'String',
    :'ignore_resource_errors' => :'BOOLEAN',
    :'tag' => :'String',
    :'help' => :'BOOLEAN',
    :'javascript' => :'BOOLEAN',
    :'referrer' => :'String',
    :'callback_url' => :'String',
    :'prince_options' => :'PrinceOptions'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/docraptor/models/doc.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      document_type == o.document_type &&
      document_content == o.document_content &&
      document_url == o.document_url &&
      test == o.test &&
      strict == o.strict &&
      ignore_resource_errors == o.ignore_resource_errors &&
      tag == o.tag &&
      help == o.help &&
      javascript == o.javascript &&
      referrer == o.referrer &&
      callback_url == o.callback_url &&
      prince_options == o.prince_options
end

#_deserialize(type, value) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/docraptor/models/doc.rb', line 234

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

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/docraptor/models/doc.rb', line 291

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

#build_from_hash(attributes) ⇒ Object

build the object from hash



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/docraptor/models/doc.rb', line 215

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

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


205
206
207
 
# File 'lib/docraptor/models/doc.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



210
211
212
 
# File 'lib/docraptor/models/doc.rb', line 210

def hash
  [name, document_type, document_content, document_url, test, strict, ignore_resource_errors, tag, help, javascript, referrer, callback_url, prince_options].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



274
275
276
 
# File 'lib/docraptor/models/doc.rb', line 274

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



279
280
281
282
283
284
285
286
287
 
# File 'lib/docraptor/models/doc.rb', line 279

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

#to_s ⇒ Object 



269
270
271
 
# File 'lib/docraptor/models/doc.rb', line 269

def to_s
  to_hash.to_s
end