Class: DocRaptor::AsyncDocStatus

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AsyncDocStatus

Returns a new instance of AsyncDocStatus.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/docraptor/models/async_doc_status.rb', line 55

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[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'download_url']
    self.download_url = attributes[:'download_url']
  end
  
  if attributes[:'download_id']
    self.download_id = attributes[:'download_id']
  end
  
  if attributes[:'message']
    self.message = attributes[:'message']
  end
  
  if attributes[:'number_of_pages']
    self.number_of_pages = attributes[:'number_of_pages']
  end
  
  if attributes[:'validation_errors']
    self.validation_errors = attributes[:'validation_errors']
  end
  
end

Instance Attribute Details

#download_id ⇒ Object

The identifier for downloading the document with the download api.



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

def download_id
  @download_id
end

#download_url ⇒ Object

The URL where the document can be retrieved. This URL may only be used a few times.



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

def download_url
  @download_url
end

#message ⇒ Object

Additional information.



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

def message
  @message
end

#number_of_pages ⇒ Object

Number of PDF pages in document.



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

def number_of_pages
  @number_of_pages
end

#status ⇒ Object

The present status of the document. Can be queued, working, completed, and failed.



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

def status
  @status
end

#validation_errors ⇒ Object

Error information.



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

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/docraptor/models/async_doc_status.rb', line 24

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

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/docraptor/models/async_doc_status.rb', line 43

def self.swagger_types
  {
    :'status' => :'String',
    :'download_url' => :'String',
    :'download_id' => :'String',
    :'message' => :'String',
    :'number_of_pages' => :'Integer',
    :'validation_errors' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/docraptor/models/async_doc_status.rb', line 89

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      download_url == o.download_url &&
      download_id == o.download_id &&
      message == o.message &&
      number_of_pages == o.number_of_pages &&
      validation_errors == o.validation_errors
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/docraptor/models/async_doc_status.rb', line 130

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



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

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/docraptor/models/async_doc_status.rb', line 111

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


101
102
103
 
# File 'lib/docraptor/models/async_doc_status.rb', line 101

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



106
107
108
 
# File 'lib/docraptor/models/async_doc_status.rb', line 106

def hash
  [status, download_url, download_id, message, number_of_pages, validation_errors].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



170
171
172
 
# File 'lib/docraptor/models/async_doc_status.rb', line 170

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



175
176
177
178
179
180
181
182
183
 
# File 'lib/docraptor/models/async_doc_status.rb', line 175

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 



165
166
167
 
# File 'lib/docraptor/models/async_doc_status.rb', line 165

def to_s
  to_hash.to_s
end